Skip navigation links

oracle.jbo.server
Class SIFAttrHintsHelper

java.lang.Object
oracle.jbo.server.SIFAttrHintsHelper

All Implemented Interfaces:

AttributeHints, GenericHints

public class SIFAttrHintsHelper

extends java.lang.Object

implements AttributeHints

Defines access to SIF row specific 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_DISPLAY_HINT, ATTRIBUTE_DISPLAY_HINT_DISPLAY, ATTRIBUTE_DISPLAY_HINT_HIDE, ATTRIBUTE_FORM_TYPE_DETAIL, ATTRIBUTE_FORM_TYPE_SHORT, ATTRIBUTE_LABEL, ATTRIBUTE_LABEL_PLURAL, 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_MANDATORY, HINT_NAME_MAX_VALUE, HINT_NAME_MIN_LENGTH, HINT_NAME_MIN_VALUE, HINT_NAME_SECRET, HINT_NAME_TOOLTIP, HINT_NAME_UPDATEABLE, PNAME_Button, PNAME_ButtonGroup, PNAME_ComboBox, PNAME_ComboBoxLovEdit, PNAME_EnumList, PNAME_LovButton, PNAME_TextField

Fields inherited from interface oracle.jbo.GenericHints

PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP

Constructor Summary

protected

SIFAttrHintsHelper(AttributeDefImpl attr, Row row, CtrlHintsSupport ctrlHintSupport)

Method Summary

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[][]	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 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 locale) Returns the display width 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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SIFAttrHintsHelper

protected SIFAttrHintsHelper(AttributeDefImpl attr,
                             Row row,
                             CtrlHintsSupport ctrlHintSupport)

Method Detail

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

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

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

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

getControlType

public int getControlType(LocaleContext locale)

Description copied from interface: AttributeHints

Returns the preferred control type for this attribute

Specified by:

getControlType in interface AttributeHints

getDisplayWidth

public int getDisplayWidth(LocaleContext locale)

Description copied from interface: AttributeHints

Returns the display width for this attribute

Specified by:

getDisplayWidth in interface AttributeHints

getDisplayHeight

public int getDisplayHeight(LocaleContext locale)

Description copied from interface: AttributeHints

Returns the display width for this attribute

Specified by:

getDisplayHeight in interface AttributeHints

isAutoSubmit

public boolean isAutoSubmit(LocaleContext locale)

Description copied from interface: AttributeHints

Returns autoSubmit value for this attribute.

Specified by:

isAutoSubmit in interface AttributeHints

isAutoSubmitStr

public java.lang.String isAutoSubmitStr(LocaleContext locale)

getHint

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

Description copied from interface: AttributeHints

Return defaulted hint value based on the hint name

Specified by:

getHint in interface AttributeHints

getHintValue

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

Description copied from interface: GenericHints

Return hint value based on the hint name

Specified by:

getHintValue in interface GenericHints

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

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

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

getFormattedAttribute

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

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

parseFormattedAttribute

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

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

displayInShortForm

public boolean displayInShortForm(LocaleContext locale)

Description copied from interface: AttributeHints

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

Specified by:

displayInShortForm in interface AttributeHints

getFormat

public java.lang.String getFormat(LocaleContext locale)

Description copied from interface: AttributeHints

returns the format string stored in the ui hints

Specified by:

getFormat in interface AttributeHints

getFormatter

public Formatter getFormatter(LocaleContext locale)

Description copied from interface: AttributeHints

returns the formatter object stored in the ui hints

Specified by:

getFormatter in interface AttributeHints

getFormatterClassName

public java.lang.String getFormatterClassName(LocaleContext locale)

Description copied from interface: AttributeHints

returns the formatter class stored in the ui hints

Specified by:

getFormatterClassName in interface AttributeHints

getAllHints

public java.util.HashMap getAllHints(LocaleContext locale)

Skip navigation links