Package org.cyclos.model.system.fields
Enum CustomFieldType
- java.lang.Object
-
- java.lang.Enum<CustomFieldType>
-
- org.cyclos.model.system.fields.CustomFieldType
-
- All Implemented Interfaces:
Serializable,Comparable<CustomFieldType>,HasMessageKey
public enum CustomFieldType extends Enum<CustomFieldType> implements HasMessageKey
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BOOLEANA boolean numberDATEA date (without time)DECIMALA decimal numberDYNAMIC_MULTI_SELECTIONAn enumerated value whose possible values are dynamically generated by a script and allows multiple selectionDYNAMIC_SELECTIONAn enumerated value whose possible values are dynamically generated by a scriptFILEA stored fileIMAGEA stored imageINTEGERAn integer numberLINKED_ENTITYA linked entityMULTI_SELECTIONAn enumerated value which allows a multiple selectionRICH_TEXTRich textSINGLE_SELECTIONAn enumerated value which allows a single selectionSTRINGSingle line string or masked textTEXTMulti line stringURLAn URL
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanHaveLoadValuesScript()Returns whether this field type can have a script to load possible valuesbooleancanHaveValuesOnSearch()Returns whether this field type, when used as search filter, can have possible values loadedMessageKeygetMessageKey()List<CustomFieldControl>getPossibleControls(boolean hasLoadValuesScript)booleanhasMultipleValues()Returns whether this type supports multiple valuesbooleanisAllowedToBeOnResultList()Returns whether this field type is allowed to be in a result listbooleanisAllowedToBeOnSearchFilters()Returns whether this field type is allowed to be on search filtersbooleanisBinary()Returns whether this field is a binary file (or image)booleanisDynamic()Returns whether this field type has dynamic enumerated valuesbooleanisEnumerated()Returns whether this field type allows enumerated valuesbooleanisSearchable()Returns whether this field can be used in keywords searchbooleanisSingleString()Returns whether values of this type represents simple stringsbooleanisSortable()booleanisString()Returns whether values of this type are stringsbooleanisUseSize(CustomFieldControl control)Returns whether this field type uses size taking into account the given controlstatic CustomFieldTypevalueOf(String name)Returns the enum constant of this type with the specified name.static CustomFieldType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
STRING
public static final CustomFieldType STRING
Single line string or masked text
-
TEXT
public static final CustomFieldType TEXT
Multi line string
-
RICH_TEXT
public static final CustomFieldType RICH_TEXT
Rich text
-
SINGLE_SELECTION
public static final CustomFieldType SINGLE_SELECTION
An enumerated value which allows a single selection
-
MULTI_SELECTION
public static final CustomFieldType MULTI_SELECTION
An enumerated value which allows a multiple selection
-
DYNAMIC_SELECTION
public static final CustomFieldType DYNAMIC_SELECTION
An enumerated value whose possible values are dynamically generated by a script
-
DYNAMIC_MULTI_SELECTION
public static final CustomFieldType DYNAMIC_MULTI_SELECTION
An enumerated value whose possible values are dynamically generated by a script and allows multiple selection
-
INTEGER
public static final CustomFieldType INTEGER
An integer number
-
DECIMAL
public static final CustomFieldType DECIMAL
A decimal number
-
DATE
public static final CustomFieldType DATE
A date (without time)
-
BOOLEAN
public static final CustomFieldType BOOLEAN
A boolean number
-
URL
public static final CustomFieldType URL
An URL
-
LINKED_ENTITY
public static final CustomFieldType LINKED_ENTITY
A linked entity
-
FILE
public static final CustomFieldType FILE
A stored file
-
IMAGE
public static final CustomFieldType IMAGE
A stored image
-
-
Method Detail
-
values
public static CustomFieldType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (CustomFieldType c : CustomFieldType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CustomFieldType 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 nameNullPointerException- if the argument is null
-
canHaveLoadValuesScript
public boolean canHaveLoadValuesScript()
Returns whether this field type can have a script to load possible values
-
canHaveValuesOnSearch
public boolean canHaveValuesOnSearch()
Returns whether this field type, when used as search filter, can have possible values loaded
-
getMessageKey
public MessageKey getMessageKey()
- Specified by:
getMessageKeyin interfaceHasMessageKey
-
getPossibleControls
public List<CustomFieldControl> getPossibleControls(boolean hasLoadValuesScript)
-
hasMultipleValues
public boolean hasMultipleValues()
Returns whether this type supports multiple values
-
isAllowedToBeOnResultList
public boolean isAllowedToBeOnResultList()
Returns whether this field type is allowed to be in a result list
-
isAllowedToBeOnSearchFilters
public boolean isAllowedToBeOnSearchFilters()
Returns whether this field type is allowed to be on search filters
-
isBinary
public boolean isBinary()
Returns whether this field is a binary file (or image)
-
isDynamic
public boolean isDynamic()
Returns whether this field type has dynamic enumerated values
-
isEnumerated
public boolean isEnumerated()
Returns whether this field type allows enumerated values
-
isSearchable
public boolean isSearchable()
Returns whether this field can be used in keywords search
-
isSingleString
public boolean isSingleString()
Returns whether values of this type represents simple strings
-
isSortable
public boolean isSortable()
-
isString
public boolean isString()
Returns whether values of this type are strings
-
isUseSize
public boolean isUseSize(CustomFieldControl control)
Returns whether this field type uses size taking into account the given control
-
-