public class SIFAttrHintsHelper extends java.lang.Object implements AttributeHints
AttributeDef
AttributeHints.ControlType
ATTRIBUTE_AUTOSUBMIT, ATTRIBUTE_BINDEDITOR_LABEL, ATTRIBUTE_CTL_CATEGORY, ATTRIBUTE_CTL_DISPLAYHEIGHT, ATTRIBUTE_CTL_DISPLAYWIDTH, ATTRIBUTE_CTL_FIELD_ORDER, ATTRIBUTE_CTL_FORMTYPE, ATTRIBUTE_CTL_TYPE, ATTRIBUTE_DEFINITION_STATE, ATTRIBUTE_DISPLAY_HINT, ATTRIBUTE_DISPLAY_HINT_DISPLAY, ATTRIBUTE_DISPLAY_HINT_HIDE, ATTRIBUTE_FORM_TYPE_DETAIL, ATTRIBUTE_FORM_TYPE_SHORT, ATTRIBUTE_LABEL, ATTRIBUTE_LABEL_PLURAL, ATTRIBUTE_LOVNAME, ATTRIBUTE_PAYLOAD_HINT, ATTRIBUTE_PAYLOAD_HINT_HIDE, ATTRIBUTE_PAYLOAD_HINT_SHOW, ATTRIBUTE_REQUIRED_HINT, ATTRIBUTE_REQUIRED_HINT_OPTIONAL, ATTRIBUTE_REQUIRED_HINT_REQUIRED, ATTRIBUTE_REQUIRED_HINT_SELECTIVELY_REQUIRED, ATTRIBUTE_TIMEZONE_ID, ATTRIBUTE_TOOLTIP, CTL_CHECK_BOX, CTL_CHOICE_LIST, CTL_COMBO_BOX, CTL_COMBO_BOX_LOV, CTL_DATE, CTL_DEFAULT, CTL_DELIMITEDIDS_CHOICE, CTL_EDIT, CTL_IMAGE, CTL_INPUT_TEXT_LOV, CTL_LIST_BOX, CTL_NUMBER_EDIT, CTL_RADIO_GROUP, CTLTYPE_CHECKBOX, CTLTYPE_COMBO, CTLTYPE_COMBOLOV, CTLTYPE_DATE, CTLTYPE_DEFAULT, CTLTYPE_DELIMITEDIDS_CHOICE, CTLTYPE_EDIT, CTLTYPE_IMAGE, CTLTYPE_LIST, CTLTYPE_LISTBOX, CTLTYPE_LOV, CTLTYPE_NUMEDIT, CTLTYPE_RADIOGRP, CTLTYPE_TOGGLE, FMT_FORMAT, FMT_FORMATTER, HINT_NAME_AUTOSUBMIT, HINT_NAME_CATEGORY, HINT_NAME_CTL_TYPE, HINT_NAME_DESCRIPTION, HINT_NAME_DISPLAY_HEIGHT, HINT_NAME_DISPLAY_HINT, HINT_NAME_DISPLAY_WIDTH, HINT_NAME_FIELD_ORDER, HINT_NAME_FORMAT, HINT_NAME_LABEL, HINT_NAME_LABEL_PLURAL, HINT_NAME_LOVNAME, HINT_NAME_MANDATORY, HINT_NAME_MAX_LENGTH, HINT_NAME_MAX_VALUE, HINT_NAME_MIN_LENGTH, HINT_NAME_MIN_VALUE, HINT_NAME_PAYLOAD_HINT, HINT_NAME_SECRET, HINT_NAME_TIMEZONEID, HINT_NAME_TOOLTIP, HINT_NAME_UPDATEABLE, HINT_NAME_WATERMARK, PNAME_Button, PNAME_ButtonGroup, PNAME_ComboBox, PNAME_ComboBoxLovEdit, PNAME_ENSURE_KEY_ATTR, PNAME_EnumList, PNAME_LovButton, PNAME_ROWNUMATTR, PNAME_SOURCENAME_ACCESSOR, PNAME_SOURCENAME_ATTR, PNAME_TextField
DEFINITION_STATE_ACTIVE, DEFINITION_STATE_DEPRECATED, PROPERTY_DEFINITION_STATE, PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP
Modifier | Constructor and Description |
---|---|
protected |
SIFAttrHintsHelper(AttributeDefImpl attr,
Row row,
CtrlHintsSupport ctrlHintSupport) |
Modifier and Type | Method and Description |
---|---|
boolean |
displayInShortForm(LocaleContext locale)
Returns true if the attribute is to displayed in the short(summary) form.
|
java.util.HashMap |
getAllHints(LocaleContext locale) |
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
|
java.lang.String |
getDefinitionState(LocaleContext locale)
Retrives the definition state string that indicates if this object is deprecated.
|
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 |
getHintValue(LocaleContext locale,
java.lang.String sHintName)
Return hint value based on the hint name
|
java.lang.String |
getLabel(LocaleContext locale)
Retrieves the label to be used in any attribute prompts
|
java.lang.String |
getLabelPlural(LocaleContext locale)
Retrives the LabelPlural text to be used for this attribute
|
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.
|
java.lang.String |
getTooltip(LocaleContext locale)
Retrives the tooltip text to be used for this attribute
|
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.String |
isAutoSubmitStr(LocaleContext locale) |
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.
|
protected SIFAttrHintsHelper(AttributeDefImpl attr, Row row, CtrlHintsSupport ctrlHintSupport)
public java.lang.String getLabel(LocaleContext locale)
GenericHints
getLabel
in interface GenericHints
public java.lang.String getLabelPlural(LocaleContext locale)
GenericHints
getLabelPlural
in interface GenericHints
public java.lang.String getDefinitionState(LocaleContext locale)
GenericHints
getDefinitionState
in interface GenericHints
public java.lang.String getTooltip(LocaleContext locale)
GenericHints
getTooltip
in interface GenericHints
public java.lang.String getDisplayHint(LocaleContext locale)
AttributeHints
getDisplayHint
in interface AttributeHints
public java.lang.String getPayloadHint(LocaleContext locale)
AttributeHints
getPayloadHint
in interface AttributeHints
public int getControlType(LocaleContext locale)
AttributeHints
getControlType
in interface AttributeHints
public int getDisplayWidth(LocaleContext locale)
AttributeHints
getDisplayWidth
in interface AttributeHints
public int getDisplayHeight(LocaleContext locale)
AttributeHints
getDisplayHeight
in interface AttributeHints
public boolean isAutoSubmit(LocaleContext locale)
AttributeHints
isAutoSubmit
in interface AttributeHints
public java.lang.String isAutoSubmitStr(LocaleContext locale)
public double getFieldOrder(LocaleContext locale)
AttributeHints
getFieldOrder
in interface AttributeHints
public java.lang.String getCategory(LocaleContext locale)
AttributeHints
getCategory
in interface AttributeHints
public java.lang.String getLOVName()
AttributeHints
getLOVName
in interface AttributeHints
public java.lang.String getHint(LocaleContext locale, java.lang.String sHintName)
AttributeHints
getHint
in interface AttributeHints
public java.lang.String getHintValue(LocaleContext locale, java.lang.String sHintName)
GenericHints
getHintValue
in interface GenericHints
public java.lang.String getLocaleName(LocaleContext locale, java.lang.String sName)
AttributeHints
getLocaleName
in interface AttributeHints
public java.lang.String[][] getCompOpers(LocaleContext locale)
AttributeHints
getCompOpers
in interface AttributeHints
public boolean hasFormatInformation(LocaleContext locale)
AttributeHints
hasFormatInformation
in interface AttributeHints
public java.lang.String getFormattedAttribute(AttributeList attrList, LocaleContext locale)
AttributeHints
getFormattedAttribute
in interface AttributeHints
public java.lang.Object parseFormattedAttribute(java.lang.String sValue, LocaleContext locale)
AttributeHints
parseFormattedAttribute
in interface AttributeHints
public boolean displayInShortForm(LocaleContext locale)
AttributeHints
displayInShortForm
in interface AttributeHints
public java.lang.String getFormat(LocaleContext locale)
AttributeHints
getFormat
in interface AttributeHints
public Formatter getFormatter(LocaleContext locale)
AttributeHints
getFormatter
in interface AttributeHints
public java.lang.String getFormatterClassName(LocaleContext locale)
AttributeHints
getFormatterClassName
in interface AttributeHints
public java.util.HashMap getAllHints(LocaleContext locale)