oracle.jbo.server

Class EntityAttrHintsImpl

java.lang.Object

oracle.jbo.server.RowAttrHintsImpl

oracle.jbo.server.EntityAttrHintsImpl

All Implemented Interfaces:

AttributeHints, GenericHints

public class EntityAttrHintsImpl
extends RowAttrHintsImpl

Defines access to an entity Attribute's user interface hints.

Since:

JDeveloper 9.0.2

See Also:

AttributeDef

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.jbo.AttributeHints

AttributeHints.ControlType

Field Summary

Fields inherited from interface oracle.jbo.AttributeHints

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_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

Fields inherited from interface oracle.jbo.GenericHints

DEFINITION_STATE_ACTIVE, DEFINITION_STATE_DEPRECATED, PROPERTY_DEFINITION_STATE, PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityAttrHintsImpl(AttributeDefImpl attr, EntityImpl en) for use by subclasses.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	displayInShortForm(LocaleContext localeCtx) Returns true if the attribute is to displayed in the short(summary) form.
protected AttributeDefImpl	getAttributeDefImpl()
protected AttributeHints	getAttributeHintsInternal(java.lang.String hintName, 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 localeCtx) 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 localeCtx) Returns the display width 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 localeCtx) Returns the display width for this attribute
protected EntityImpl	getEntityImpl()
double	getFieldOrder(LocaleContext localeCtx) Returns the field order for this attribute.
java.lang.String	getFormat(LocaleContext localeCtx) returns the format string stored in the ui hints
protected AttributeHints	getFormatAttributeHintsInternal(LocaleContext locale)
java.lang.String	getFormattedAttribute(AttributeList attrList, LocaleContext localeCtx) Returns the formatted value for the attribute.
Formatter	getFormatter(LocaleContext localeCtx) returns the formatter object stored in the ui hints
java.lang.String	getFormatterClassName(LocaleContext localeCtx) returns the formatter class stored in the ui hints
java.lang.String	getHint(LocaleContext localeCtx, java.lang.String sHintName) Return defaulted hint value based on the hint name
java.lang.String	getHintValue(LocaleContext localeCtx, 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	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 localeCtx) Returns autoSubmit value for this attribute.
java.lang.Object	parseFormattedAttribute(java.lang.String sValue, LocaleContext localeCtx) 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.

Methods inherited from class oracle.jbo.server.RowAttrHintsImpl

getLOVName, prepareDefLocaleContext, switchEvalFlagOnLocaleContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityAttrHintsImpl

protected EntityAttrHintsImpl(AttributeDefImpl attr,
                   EntityImpl en)

for use by subclasses.

Method Detail

getAttributeDefImpl

protected AttributeDefImpl getAttributeDefImpl()

getEntityImpl

protected EntityImpl getEntityImpl()

getFormatAttributeHintsInternal

protected AttributeHints getFormatAttributeHintsInternal(LocaleContext locale)

Specified by:

getFormatAttributeHintsInternal in class RowAttrHintsImpl

getAttributeHintsInternal

protected AttributeHints getAttributeHintsInternal(java.lang.String hintName,
                                       LocaleContext locale)

Specified by:

getAttributeHintsInternal in class RowAttrHintsImpl

getLabel

public java.lang.String getLabel(LocaleContext locale)

Description copied from interface: GenericHints

Retrieves the label to be used in any attribute prompts

Specified by:

getLabel in interface GenericHints

Overrides:

getLabel in class RowAttrHintsImpl

getLabelPlural

public java.lang.String getLabelPlural(LocaleContext locale)

Description copied from interface: GenericHints

Retrives the LabelPlural text to be used for this attribute

Specified by:

getLabelPlural in interface GenericHints

Overrides:

getLabelPlural in class RowAttrHintsImpl

getTooltip

public java.lang.String getTooltip(LocaleContext locale)

Description copied from interface: GenericHints

Retrives the tooltip text to be used for this attribute

Specified by:

getTooltip in interface GenericHints

Overrides:

getTooltip in class RowAttrHintsImpl

getDefinitionState

public java.lang.String getDefinitionState(LocaleContext locale)

Description copied from interface: GenericHints

Retrives the definition state string that indicates if this object is deprecated. The two possible values are: DEFINITION_STATE_ACTIVE DEFINITION_STATE_DEPRECATED

Specified by:

getDefinitionState in interface GenericHints

Overrides:

getDefinitionState in class RowAttrHintsImpl

getDisplayHint

public java.lang.String getDisplayHint(LocaleContext locale)

Description copied from interface: AttributeHints

Retrieves the displya hint that dictates whether this attributr should be visible or not. The two possible values are: ATTRIBUTE_DISPLAY_HINT_DISPLAY = "Display"; ATTRIBUTE_DISPLAY_HINT_HIDE = "Hide";

Specified by:

getDisplayHint in interface AttributeHints

Overrides:

getDisplayHint in class RowAttrHintsImpl

getPayloadHint

public java.lang.String getPayloadHint(LocaleContext locale)

Description copied from interface: AttributeHints

Retrieves the payload hint that dictates whether this attribute should be included in service payload or not. The possible values are:

• ATTRIBUTE_PAYLOAD_HINT_HIDE
• null

Specified by:

getPayloadHint in interface AttributeHints

Overrides:

getPayloadHint in class RowAttrHintsImpl

getControlType

public int getControlType(LocaleContext localeCtx)

Description copied from interface: AttributeHints

Returns the preferred control type for this attribute

Specified by:

getControlType in interface AttributeHints

Overrides:

getControlType in class RowAttrHintsImpl

getDisplayWidth

public int getDisplayWidth(LocaleContext localeCtx)

Description copied from interface: AttributeHints

Returns the display width for this attribute

Specified by:

getDisplayWidth in interface AttributeHints

Overrides:

getDisplayWidth in class RowAttrHintsImpl

getDisplayHeight

public int getDisplayHeight(LocaleContext localeCtx)

Description copied from interface: AttributeHints

Returns the display width for this attribute

Specified by:

getDisplayHeight in interface AttributeHints

Overrides:

getDisplayHeight in class RowAttrHintsImpl

isAutoSubmit

public boolean isAutoSubmit(LocaleContext localeCtx)

Description copied from interface: AttributeHints

Returns autoSubmit value for this attribute.

Specified by:

isAutoSubmit in interface AttributeHints

Overrides:

isAutoSubmit in class RowAttrHintsImpl

getFieldOrder

public double getFieldOrder(LocaleContext localeCtx)

Description copied from interface: AttributeHints

Returns the field order for this attribute.

Specified by:

getFieldOrder in interface AttributeHints

Overrides:

getFieldOrder in class RowAttrHintsImpl

getCategory

public java.lang.String getCategory(LocaleContext locale)

Description copied from interface: AttributeHints

Returns the category that this attribute belongs to.

Specified by:

getCategory in interface AttributeHints

Overrides:

getCategory in class RowAttrHintsImpl

getHint

public java.lang.String getHint(LocaleContext localeCtx,
                       java.lang.String sHintName)

Description copied from interface: AttributeHints

Return defaulted hint value based on the hint name

Specified by:

getHint in interface AttributeHints

Overrides:

getHint in class RowAttrHintsImpl

getHintValue

public java.lang.String getHintValue(LocaleContext localeCtx,
                            java.lang.String sHintName)

Description copied from interface: GenericHints

Return hint value based on the hint name

Specified by:

getHintValue in interface GenericHints

Overrides:

getHintValue in class RowAttrHintsImpl

hasFormatInformation

public boolean hasFormatInformation(LocaleContext locale)

Description copied from interface: AttributeHints

Return true if any format hints have been defined for this attribute. This function should eb used to bracket any calls to the formatting api.

Specified by:

hasFormatInformation in interface AttributeHints

Overrides:

hasFormatInformation in class RowAttrHintsImpl

getFormattedAttribute

public java.lang.String getFormattedAttribute(AttributeList attrList,
                                     LocaleContext localeCtx)

Description copied from interface: AttributeHints

Returns the formatted value for the attribute. The AttributeList parameter will usually be an instance of the oracle.jbo.Row class.

Specified by:

getFormattedAttribute in interface AttributeHints

Overrides:

getFormattedAttribute in class RowAttrHintsImpl

parseFormattedAttribute

public java.lang.Object parseFormattedAttribute(java.lang.String sValue,
                                       LocaleContext localeCtx)

Description copied from interface: AttributeHints

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.

Specified by:

parseFormattedAttribute in interface AttributeHints

Overrides:

parseFormattedAttribute in class RowAttrHintsImpl

displayInShortForm

public boolean displayInShortForm(LocaleContext localeCtx)

Description copied from interface: AttributeHints

Returns true if the attribute is to displayed in the short(summary) form.

Specified by:

displayInShortForm in interface AttributeHints

Overrides:

displayInShortForm in class RowAttrHintsImpl

getFormat

public java.lang.String getFormat(LocaleContext localeCtx)

Description copied from interface: AttributeHints

returns the format string stored in the ui hints

Specified by:

getFormat in interface AttributeHints

Overrides:

getFormat in class RowAttrHintsImpl

getFormatter

public Formatter getFormatter(LocaleContext localeCtx)

Description copied from interface: AttributeHints

returns the formatter object stored in the ui hints

Specified by:

getFormatter in interface AttributeHints

Overrides:

getFormatter in class RowAttrHintsImpl

getFormatterClassName

public java.lang.String getFormatterClassName(LocaleContext localeCtx)

Description copied from interface: AttributeHints

returns the formatter class stored in the ui hints

Specified by:

getFormatterClassName in interface AttributeHints

Overrides:

getFormatterClassName in class RowAttrHintsImpl

getLocaleName

public java.lang.String getLocaleName(LocaleContext locale,
                             java.lang.String sName)

Description copied from interface: AttributeHints

function for retrieving the locale name of a hint

Specified by:

getLocaleName in interface AttributeHints

Specified by:

getLocaleName in class RowAttrHintsImpl

getCompOpers

public java.lang.String[][] getCompOpers(LocaleContext locale)

Description copied from interface: AttributeHints

Returns a Map of operators for this attribute.

Specified by:

getCompOpers in interface AttributeHints

Specified by:

getCompOpers in class RowAttrHintsImpl