public interface AttributeHints extends GenericHints
AttributeDef
Modifier and Type | Interface and Description |
---|---|
static class |
AttributeHints.ControlType |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRIBUTE_AUTOSUBMIT |
static java.lang.String |
ATTRIBUTE_BINDEDITOR_LABEL |
static java.lang.String |
ATTRIBUTE_CTL_CATEGORY |
static java.lang.String |
ATTRIBUTE_CTL_DISPLAYHEIGHT |
static java.lang.String |
ATTRIBUTE_CTL_DISPLAYWIDTH |
static java.lang.String |
ATTRIBUTE_CTL_FIELD_ORDER |
static java.lang.String |
ATTRIBUTE_CTL_FORMTYPE |
static java.lang.String |
ATTRIBUTE_CTL_TYPE |
static java.lang.String |
ATTRIBUTE_DEFINITION_STATE |
static java.lang.String |
ATTRIBUTE_DISPLAY_HINT |
static java.lang.String |
ATTRIBUTE_DISPLAY_HINT_DISPLAY |
static java.lang.String |
ATTRIBUTE_DISPLAY_HINT_HIDE |
static java.lang.String |
ATTRIBUTE_FORM_TYPE_DETAIL |
static java.lang.String |
ATTRIBUTE_FORM_TYPE_SHORT |
static java.lang.String |
ATTRIBUTE_LABEL
These hints above do not have specific hint api
|
static java.lang.String |
ATTRIBUTE_LABEL_PLURAL |
static java.lang.String |
ATTRIBUTE_LOVNAME |
static java.lang.String |
ATTRIBUTE_PAYLOAD_HINT |
static java.lang.String |
ATTRIBUTE_PAYLOAD_HINT_HIDE |
static java.lang.String |
ATTRIBUTE_PAYLOAD_HINT_SHOW |
static java.lang.String |
ATTRIBUTE_REQUIRED_HINT |
static java.lang.String |
ATTRIBUTE_REQUIRED_HINT_OPTIONAL |
static java.lang.String |
ATTRIBUTE_REQUIRED_HINT_REQUIRED |
static java.lang.String |
ATTRIBUTE_REQUIRED_HINT_SELECTIVELY_REQUIRED |
static java.lang.String |
ATTRIBUTE_TIMEZONE_ID |
static java.lang.String |
ATTRIBUTE_TOOLTIP |
static java.lang.String |
CTL_CHECK_BOX |
static java.lang.String |
CTL_CHOICE_LIST |
static java.lang.String |
CTL_COMBO_BOX |
static java.lang.String |
CTL_COMBO_BOX_LOV |
static java.lang.String |
CTL_DATE |
static java.lang.String |
CTL_DEFAULT
String values for Control type control hint.
|
static java.lang.String |
CTL_DELIMITEDIDS_CHOICE |
static java.lang.String |
CTL_EDIT |
static java.lang.String |
CTL_IMAGE |
static java.lang.String |
CTL_INPUT_TEXT_LOV |
static java.lang.String |
CTL_LIST_BOX |
static java.lang.String |
CTL_NUMBER_EDIT |
static java.lang.String |
CTL_RADIO_GROUP |
static int |
CTLTYPE_CHECKBOX |
static int |
CTLTYPE_COMBO |
static int |
CTLTYPE_COMBOLOV |
static int |
CTLTYPE_DATE |
static int |
CTLTYPE_DEFAULT |
static int |
CTLTYPE_DELIMITEDIDS_CHOICE |
static int |
CTLTYPE_EDIT |
static int |
CTLTYPE_IMAGE |
static int |
CTLTYPE_LIST |
static int |
CTLTYPE_LISTBOX |
static int |
CTLTYPE_LOV |
static int |
CTLTYPE_NUMEDIT |
static int |
CTLTYPE_RADIOGRP |
static int |
CTLTYPE_TOGGLE |
static java.lang.String |
FMT_FORMAT |
static java.lang.String |
FMT_FORMATTER |
static java.lang.String |
HINT_NAME_AUTOSUBMIT |
static java.lang.String |
HINT_NAME_CATEGORY |
static java.lang.String |
HINT_NAME_CTL_TYPE |
static java.lang.String |
HINT_NAME_DESCRIPTION |
static java.lang.String |
HINT_NAME_DISPLAY_HEIGHT |
static java.lang.String |
HINT_NAME_DISPLAY_HINT |
static java.lang.String |
HINT_NAME_DISPLAY_WIDTH |
static java.lang.String |
HINT_NAME_FIELD_ORDER |
static java.lang.String |
HINT_NAME_FORMAT |
static java.lang.String |
HINT_NAME_LABEL |
static java.lang.String |
HINT_NAME_LABEL_PLURAL |
static java.lang.String |
HINT_NAME_LOVNAME |
static java.lang.String |
HINT_NAME_MANDATORY |
static java.lang.String |
HINT_NAME_MAX_LENGTH |
static java.lang.String |
HINT_NAME_MAX_VALUE |
static java.lang.String |
HINT_NAME_MIN_LENGTH |
static java.lang.String |
HINT_NAME_MIN_VALUE
These hints below do not have specific hint api
|
static java.lang.String |
HINT_NAME_PAYLOAD_HINT |
static java.lang.String |
HINT_NAME_SECRET |
static java.lang.String |
HINT_NAME_TIMEZONEID |
static java.lang.String |
HINT_NAME_TOOLTIP |
static java.lang.String |
HINT_NAME_UPDATEABLE |
static java.lang.String |
HINT_NAME_WATERMARK |
static java.lang.String |
PNAME_Button |
static java.lang.String |
PNAME_ButtonGroup |
static java.lang.String |
PNAME_ComboBox |
static java.lang.String |
PNAME_ComboBoxLovEdit |
static java.lang.String |
PNAME_ENSURE_KEY_ATTR
Deprecated.
|
static java.lang.String |
PNAME_EnumList |
static java.lang.String |
PNAME_LovButton |
static java.lang.String |
PNAME_ROWNUMATTR
Deprecated.
|
static java.lang.String |
PNAME_SOURCENAME_ACCESSOR
Deprecated.
|
static java.lang.String |
PNAME_SOURCENAME_ATTR
Deprecated.
|
static java.lang.String |
PNAME_TextField |
DEFINITION_STATE_ACTIVE, DEFINITION_STATE_DEPRECATED, PROPERTY_DEFINITION_STATE, PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP
Modifier and Type | Method and Description |
---|---|
boolean |
displayInShortForm(LocaleContext locale)
Returns true if the attribute is to displayed in the short(summary) form.
|
java.lang.String |
getCategory(LocaleContext locale)
Returns the category that this attribute belongs to.
|
java.lang.String[][] |
getCompOpers(LocaleContext locale)
Returns a Map of operators for this attribute.
|
int |
getControlType(LocaleContext locale)
Returns the preferred control type for this attribute
|
int |
getDisplayHeight(LocaleContext locale)
Returns the display height for this attribute
|
java.lang.String |
getDisplayHint(LocaleContext locale)
Retrieves the displya hint that dictates whether this
attributr should be visible or not.
|
int |
getDisplayWidth(LocaleContext locale)
Returns the display width for this attribute
|
double |
getFieldOrder(LocaleContext locale)
Returns the field order for this attribute.
|
java.lang.String |
getFormat(LocaleContext locale)
returns the format string stored in the ui hints
|
java.lang.String |
getFormattedAttribute(AttributeList attrList,
LocaleContext locale)
Returns the formatted value for the attribute.
|
Formatter |
getFormatter(LocaleContext locale)
returns the formatter object stored in the ui hints
|
java.lang.String |
getFormatterClassName(LocaleContext locale)
returns the formatter class stored in the ui hints
|
java.lang.String |
getHint(LocaleContext locale,
java.lang.String sHintName)
Return defaulted hint value based on the hint name
|
java.lang.String |
getLocaleName(LocaleContext locale,
java.lang.String sName)
function for retrieving the locale name of a hint
|
java.lang.String |
getLOVName()
Returns the name of the LOV defined on this attribute.
|
java.lang.String |
getPayloadHint(LocaleContext locale)
Retrieves the payload hint that dictates whether this
attribute should be included in service payload or not.
|
boolean |
hasFormatInformation(LocaleContext locale)
Return true if any format hints have been defined for this
attribute.
|
boolean |
isAutoSubmit(LocaleContext locale)
Returns autoSubmit value for this attribute.
|
java.lang.Object |
parseFormattedAttribute(java.lang.String sValue,
LocaleContext locale)
Strips off the formatting from a string and constructs an
instance of the attribute's domain using the 'clean' string as
a parameter of the contructor.
|
getDefinitionState, getHintValue, getLabel, getLabelPlural, getTooltip
static final java.lang.String HINT_NAME_LABEL
static final java.lang.String HINT_NAME_LABEL_PLURAL
static final java.lang.String HINT_NAME_FORMAT
static final java.lang.String HINT_NAME_TOOLTIP
static final java.lang.String HINT_NAME_DISPLAY_HINT
static final java.lang.String HINT_NAME_DISPLAY_HEIGHT
static final java.lang.String HINT_NAME_DISPLAY_WIDTH
static final java.lang.String HINT_NAME_MANDATORY
static final java.lang.String HINT_NAME_UPDATEABLE
static final java.lang.String HINT_NAME_CTL_TYPE
static final java.lang.String HINT_NAME_AUTOSUBMIT
static final java.lang.String HINT_NAME_PAYLOAD_HINT
static final java.lang.String HINT_NAME_DESCRIPTION
static final java.lang.String HINT_NAME_LOVNAME
static final java.lang.String HINT_NAME_FIELD_ORDER
static final java.lang.String HINT_NAME_CATEGORY
static final java.lang.String HINT_NAME_MIN_VALUE
static final java.lang.String HINT_NAME_MAX_VALUE
static final java.lang.String HINT_NAME_SECRET
static final java.lang.String HINT_NAME_WATERMARK
static final java.lang.String HINT_NAME_MIN_LENGTH
static final java.lang.String HINT_NAME_MAX_LENGTH
static final java.lang.String HINT_NAME_TIMEZONEID
static final java.lang.String ATTRIBUTE_LABEL
static final java.lang.String ATTRIBUTE_LABEL_PLURAL
static final java.lang.String ATTRIBUTE_TOOLTIP
static final java.lang.String ATTRIBUTE_DEFINITION_STATE
static final java.lang.String ATTRIBUTE_DISPLAY_HINT
static final java.lang.String ATTRIBUTE_CTL_TYPE
static final java.lang.String ATTRIBUTE_CTL_DISPLAYWIDTH
static final java.lang.String ATTRIBUTE_CTL_DISPLAYHEIGHT
static final java.lang.String ATTRIBUTE_CTL_FORMTYPE
static final java.lang.String ATTRIBUTE_BINDEDITOR_LABEL
static final java.lang.String ATTRIBUTE_AUTOSUBMIT
static final java.lang.String ATTRIBUTE_TIMEZONE_ID
static final java.lang.String ATTRIBUTE_LOVNAME
static final java.lang.String ATTRIBUTE_PAYLOAD_HINT
static final java.lang.String ATTRIBUTE_REQUIRED_HINT
static final java.lang.String ATTRIBUTE_CTL_FIELD_ORDER
static final java.lang.String ATTRIBUTE_CTL_CATEGORY
static final int CTLTYPE_DEFAULT
static final int CTLTYPE_EDIT
static final int CTLTYPE_DATE
static final int CTLTYPE_TOGGLE
static final int CTLTYPE_IMAGE
static final int CTLTYPE_LOV
static final int CTLTYPE_LIST
static final int CTLTYPE_COMBO
static final int CTLTYPE_CHECKBOX
static final int CTLTYPE_RADIOGRP
static final int CTLTYPE_NUMEDIT
static final int CTLTYPE_COMBOLOV
static final int CTLTYPE_LISTBOX
static final int CTLTYPE_DELIMITEDIDS_CHOICE
static final java.lang.String CTL_DEFAULT
static final java.lang.String CTL_EDIT
static final java.lang.String CTL_DATE
static final java.lang.String CTL_IMAGE
static final java.lang.String CTL_INPUT_TEXT_LOV
static final java.lang.String CTL_CHOICE_LIST
static final java.lang.String CTL_COMBO_BOX
static final java.lang.String CTL_CHECK_BOX
static final java.lang.String CTL_RADIO_GROUP
static final java.lang.String CTL_NUMBER_EDIT
static final java.lang.String CTL_COMBO_BOX_LOV
static final java.lang.String CTL_LIST_BOX
static final java.lang.String CTL_DELIMITEDIDS_CHOICE
static final java.lang.String ATTRIBUTE_DISPLAY_HINT_DISPLAY
static final java.lang.String ATTRIBUTE_DISPLAY_HINT_HIDE
static final java.lang.String ATTRIBUTE_PAYLOAD_HINT_HIDE
static final java.lang.String ATTRIBUTE_PAYLOAD_HINT_SHOW
static final java.lang.String ATTRIBUTE_REQUIRED_HINT_REQUIRED
static final java.lang.String ATTRIBUTE_REQUIRED_HINT_SELECTIVELY_REQUIRED
static final java.lang.String ATTRIBUTE_REQUIRED_HINT_OPTIONAL
static final java.lang.String ATTRIBUTE_FORM_TYPE_SHORT
static final java.lang.String ATTRIBUTE_FORM_TYPE_DETAIL
static final java.lang.String FMT_FORMATTER
static final java.lang.String FMT_FORMAT
static final java.lang.String PNAME_TextField
static final java.lang.String PNAME_Button
static final java.lang.String PNAME_LovButton
static final java.lang.String PNAME_ComboBox
static final java.lang.String PNAME_ComboBoxLovEdit
static final java.lang.String PNAME_ButtonGroup
static final java.lang.String PNAME_EnumList
@Concealed static final java.lang.String PNAME_ROWNUMATTR
@Concealed static final java.lang.String PNAME_ENSURE_KEY_ATTR
@Concealed static final java.lang.String PNAME_SOURCENAME_ACCESSOR
@Concealed static final java.lang.String PNAME_SOURCENAME_ATTR
java.lang.String getDisplayHint(LocaleContext locale)
java.lang.String getPayloadHint(LocaleContext locale)
int getControlType(LocaleContext locale)
int getDisplayWidth(LocaleContext locale)
int getDisplayHeight(LocaleContext locale)
java.lang.String getHint(LocaleContext locale, java.lang.String sHintName)
boolean hasFormatInformation(LocaleContext locale)
java.lang.String getFormattedAttribute(AttributeList attrList, LocaleContext locale)
java.lang.Object parseFormattedAttribute(java.lang.String sValue, LocaleContext locale)
boolean displayInShortForm(LocaleContext locale)
java.lang.String getFormat(LocaleContext locale)
Formatter getFormatter(LocaleContext locale)
java.lang.String getFormatterClassName(LocaleContext locale)
java.lang.String getLocaleName(LocaleContext locale, java.lang.String sName)
java.lang.String[][] getCompOpers(LocaleContext locale)
boolean isAutoSubmit(LocaleContext locale)
double getFieldOrder(LocaleContext locale)
java.lang.String getCategory(LocaleContext locale)
java.lang.String getLOVName()