ALBPM Process API

fuego.papi
Enum ColumnFormatType

java.lang.Object
  extended by java.lang.Enum<ColumnFormatType>
      extended by fuego.papi.ColumnFormatType
All Implemented Interfaces:
fuego.resources.Internationalizable, Serializable, Comparable<ColumnFormatType>

public enum ColumnFormatType
extends Enum<ColumnFormatType>
implements fuego.resources.Internationalizable

Enumerates the column format types.


Enum Constant Summary
DATE_CUSTOM
           
DATE_FULL
           
DATE_LONG
           
DATE_MEDIUM
           
DATE_SHORT
           
DATE_TIME_FULL
           
DATE_TIME_LONG
           
DATE_TIME_MEDIUM
           
DATE_TIME_SHORT
           
NUMBER_CURRENCY
           
NUMBER_CUSTOM
           
NUMBER_DECIMAL
           
NUMBER_INTEGER
           
NUMBER_PERCENT
           
TIME_FULL
           
TIME_LONG
           
TIME_MEDIUM
           
TIME_SHORT
           
 
Method Summary
 Format getFormat(Locale locale)
          Gets the formatter for the given locale
 Format getFormat(Locale locale, String pattern)
          Gets the custom formatter for the given locale and pattern
 String getFormatPreview(Locale locale)
           
 String getFormatPreview(Locale locale, String pattern)
           
 fuego.resources.Msg getMsg()
          For internal use only.
static List<ColumnFormatType> getNumericalFormatTypes()
          Gets all numerical format types.
 String getString()
          Gets the String representation of this format type.
 String getString(Locale locale)
          Gets the localized String representation of this format type.
static List<ColumnFormatType> getTimeFormatTypes()
          Gets all time format types.
 boolean isCustom()
          Is custom format type ?
static ColumnFormatType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ColumnFormatType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DATE_FULL

public static final ColumnFormatType DATE_FULL

DATE_LONG

public static final ColumnFormatType DATE_LONG

DATE_MEDIUM

public static final ColumnFormatType DATE_MEDIUM

DATE_SHORT

public static final ColumnFormatType DATE_SHORT

DATE_TIME_FULL

public static final ColumnFormatType DATE_TIME_FULL

DATE_TIME_LONG

public static final ColumnFormatType DATE_TIME_LONG

DATE_TIME_MEDIUM

public static final ColumnFormatType DATE_TIME_MEDIUM

DATE_TIME_SHORT

public static final ColumnFormatType DATE_TIME_SHORT

DATE_CUSTOM

public static final ColumnFormatType DATE_CUSTOM

TIME_FULL

public static final ColumnFormatType TIME_FULL

TIME_LONG

public static final ColumnFormatType TIME_LONG

TIME_MEDIUM

public static final ColumnFormatType TIME_MEDIUM

TIME_SHORT

public static final ColumnFormatType TIME_SHORT

NUMBER_INTEGER

public static final ColumnFormatType NUMBER_INTEGER

NUMBER_DECIMAL

public static final ColumnFormatType NUMBER_DECIMAL

NUMBER_CURRENCY

public static final ColumnFormatType NUMBER_CURRENCY

NUMBER_PERCENT

public static final ColumnFormatType NUMBER_PERCENT

NUMBER_CUSTOM

public static final ColumnFormatType NUMBER_CUSTOM
Method Detail

values

public static final ColumnFormatType[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ColumnFormatType c : ColumnFormatType.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static ColumnFormatType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name

getString

public String getString()
Gets the String representation of this format type.

Specified by:
getString in interface fuego.resources.Internationalizable
Returns:
representation of this format type.

getString

public String getString(Locale locale)
Gets the localized String representation of this format type.

Parameters:
locale - the desired locale.
Returns:
localized representation of this format type.

getMsg

public fuego.resources.Msg getMsg()
For internal use only.


getFormat

public Format getFormat(Locale locale)
Gets the formatter for the given locale

Parameters:
locale -
Returns:
the formatter

getFormat

public Format getFormat(Locale locale,
                        String pattern)
Gets the custom formatter for the given locale and pattern

Parameters:
locale -
pattern -
Returns:
the formatter

isCustom

public boolean isCustom()
Is custom format type ?


getFormatPreview

public String getFormatPreview(Locale locale)

getFormatPreview

public String getFormatPreview(Locale locale,
                               String pattern)

getTimeFormatTypes

public static List<ColumnFormatType> getTimeFormatTypes()
Gets all time format types.

Returns:
all time format types.

getNumericalFormatTypes

public static List<ColumnFormatType> getNumericalFormatTypes()
Gets all numerical format types.

Returns:
all numerical format types.

ALBPM Process API

© Copyright 1996/2005 Fuego Inc. All Rights Reserved