Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.0.0)

E10653-01

oracle.jbo
Interface AttributeHints

All Known Implementing Classes:
AssociationDefImpl, AttributeDefImpl, AttributeDefImpl, AttributeDefImpl, AttributeDefOverAttr, AttributeHintsImpl, CmrAccessorDefImpl, DCVariableImpl, DCVCItemValueRowAttrHints, DCVCSubstAttrDef, DomainAttributeDef, EntityAttrHintsImpl, JUCtrlParameterDef, VariableImpl, ViewAttributeDefImpl, ViewCriteriaItem, ViewCriteriaItemCompound, ViewCriteriaItemCompoundImpl, ViewCriteriaItemImpl, ViewRowAttrHintsImpl

public interface AttributeHints

Defines access to an Attribute's user interface hints.

Since:
JDeveloper 9.0.2
See Also:
AttributeDef

Nested Class Summary
static class AttributeHints.ControlType
           
 
Field Summary
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_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
           
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_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_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_CATEGORY
           
static java.lang.String HINT_NAME_CTL_TYPE
           
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_MANDATORY
           
static java.lang.String HINT_NAME_TOOLTIP
           
static java.lang.String HINT_NAME_UPDATEABLE
           
static java.lang.String PNAME_Button
           
static java.lang.String PNAME_ButtonGroup
           
static java.lang.String PNAME_ComboBox
           
static java.lang.String PNAME_EnumList
           
static java.lang.String PNAME_LovButton
           
static java.lang.String PNAME_TextField
           
 
Method Summary
 boolean displayInShortForm(LocaleContext locale)
          Returns true if the attribute is to displayed in the short(summary) form.
 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 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.
 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.
 

Field Detail

ATTRIBUTE_LABEL

static final java.lang.String ATTRIBUTE_LABEL
See Also:
Constant Field Values

ATTRIBUTE_TOOLTIP

static final java.lang.String ATTRIBUTE_TOOLTIP
See Also:
Constant Field Values

ATTRIBUTE_DISPLAY_HINT

static final java.lang.String ATTRIBUTE_DISPLAY_HINT
See Also:
Constant Field Values

ATTRIBUTE_CTL_TYPE

static final java.lang.String ATTRIBUTE_CTL_TYPE
See Also:
Constant Field Values

ATTRIBUTE_CTL_DISPLAYWIDTH

static final java.lang.String ATTRIBUTE_CTL_DISPLAYWIDTH
See Also:
Constant Field Values

ATTRIBUTE_CTL_DISPLAYHEIGHT

static final java.lang.String ATTRIBUTE_CTL_DISPLAYHEIGHT
See Also:
Constant Field Values

ATTRIBUTE_CTL_FORMTYPE

static final java.lang.String ATTRIBUTE_CTL_FORMTYPE
See Also:
Constant Field Values

ATTRIBUTE_BINDEDITOR_LABEL

static final java.lang.String ATTRIBUTE_BINDEDITOR_LABEL
See Also:
Constant Field Values

ATTRIBUTE_CTL_FIELD_ORDER

static final java.lang.String ATTRIBUTE_CTL_FIELD_ORDER
See Also:
Constant Field Values

ATTRIBUTE_CTL_CATEGORY

static final java.lang.String ATTRIBUTE_CTL_CATEGORY
See Also:
Constant Field Values

HINT_NAME_LABEL

static final java.lang.String HINT_NAME_LABEL
See Also:
Constant Field Values

HINT_NAME_FORMAT

static final java.lang.String HINT_NAME_FORMAT
See Also:
Constant Field Values

HINT_NAME_TOOLTIP

static final java.lang.String HINT_NAME_TOOLTIP
See Also:
Constant Field Values

HINT_NAME_DISPLAY_HINT

static final java.lang.String HINT_NAME_DISPLAY_HINT
See Also:
Constant Field Values

HINT_NAME_DISPLAY_HEIGHT

static final java.lang.String HINT_NAME_DISPLAY_HEIGHT
See Also:
Constant Field Values

HINT_NAME_DISPLAY_WIDTH

static final java.lang.String HINT_NAME_DISPLAY_WIDTH
See Also:
Constant Field Values

HINT_NAME_MANDATORY

static final java.lang.String HINT_NAME_MANDATORY
See Also:
Constant Field Values

HINT_NAME_UPDATEABLE

static final java.lang.String HINT_NAME_UPDATEABLE
See Also:
Constant Field Values

HINT_NAME_CTL_TYPE

static final java.lang.String HINT_NAME_CTL_TYPE
See Also:
Constant Field Values

HINT_NAME_FIELD_ORDER

static final java.lang.String HINT_NAME_FIELD_ORDER
See Also:
Constant Field Values

HINT_NAME_CATEGORY

static final java.lang.String HINT_NAME_CATEGORY
See Also:
Constant Field Values

CTLTYPE_DEFAULT

static final int CTLTYPE_DEFAULT
See Also:
Constant Field Values

CTLTYPE_EDIT

static final int CTLTYPE_EDIT
See Also:
Constant Field Values

CTLTYPE_DATE

static final int CTLTYPE_DATE
See Also:
Constant Field Values

CTLTYPE_TOGGLE

static final int CTLTYPE_TOGGLE
See Also:
Constant Field Values

CTLTYPE_IMAGE

static final int CTLTYPE_IMAGE
See Also:
Constant Field Values

CTLTYPE_LOV

static final int CTLTYPE_LOV
See Also:
Constant Field Values

CTLTYPE_LIST

static final int CTLTYPE_LIST
See Also:
Constant Field Values

CTLTYPE_COMBO

static final int CTLTYPE_COMBO
See Also:
Constant Field Values

CTLTYPE_CHECKBOX

static final int CTLTYPE_CHECKBOX
See Also:
Constant Field Values

CTLTYPE_RADIOGRP

static final int CTLTYPE_RADIOGRP
See Also:
Constant Field Values

CTLTYPE_NUMEDIT

static final int CTLTYPE_NUMEDIT
See Also:
Constant Field Values

CTLTYPE_COMBOLOV

static final int CTLTYPE_COMBOLOV
See Also:
Constant Field Values

CTLTYPE_LISTBOX

static final int CTLTYPE_LISTBOX
See Also:
Constant Field Values

CTL_DEFAULT

static final java.lang.String CTL_DEFAULT
String values for Control type control hint. These control types must have an equivalent Integer representation as listed above

See Also:
Constant Field Values

CTL_EDIT

static final java.lang.String CTL_EDIT
See Also:
Constant Field Values

CTL_DATE

static final java.lang.String CTL_DATE
See Also:
Constant Field Values

CTL_IMAGE

static final java.lang.String CTL_IMAGE
See Also:
Constant Field Values

CTL_INPUT_TEXT_LOV

static final java.lang.String CTL_INPUT_TEXT_LOV
See Also:
Constant Field Values

CTL_CHOICE_LIST

static final java.lang.String CTL_CHOICE_LIST
See Also:
Constant Field Values

CTL_COMBO_BOX

static final java.lang.String CTL_COMBO_BOX
See Also:
Constant Field Values

CTL_CHECK_BOX

static final java.lang.String CTL_CHECK_BOX
See Also:
Constant Field Values

CTL_RADIO_GROUP

static final java.lang.String CTL_RADIO_GROUP
See Also:
Constant Field Values

CTL_NUMBER_EDIT

static final java.lang.String CTL_NUMBER_EDIT
See Also:
Constant Field Values

CTL_COMBO_BOX_LOV

static final java.lang.String CTL_COMBO_BOX_LOV
See Also:
Constant Field Values

CTL_LIST_BOX

static final java.lang.String CTL_LIST_BOX
See Also:
Constant Field Values

ATTRIBUTE_DISPLAY_HINT_DISPLAY

static final java.lang.String ATTRIBUTE_DISPLAY_HINT_DISPLAY
See Also:
Constant Field Values

ATTRIBUTE_DISPLAY_HINT_HIDE

static final java.lang.String ATTRIBUTE_DISPLAY_HINT_HIDE
See Also:
Constant Field Values

ATTRIBUTE_FORM_TYPE_SHORT

static final java.lang.String ATTRIBUTE_FORM_TYPE_SHORT
See Also:
Constant Field Values

ATTRIBUTE_FORM_TYPE_DETAIL

static final java.lang.String ATTRIBUTE_FORM_TYPE_DETAIL
See Also:
Constant Field Values

FMT_FORMATTER

static final java.lang.String FMT_FORMATTER
See Also:
Constant Field Values

FMT_FORMAT

static final java.lang.String FMT_FORMAT
See Also:
Constant Field Values

PNAME_TextField

static final java.lang.String PNAME_TextField
See Also:
Constant Field Values

PNAME_Button

static final java.lang.String PNAME_Button
See Also:
Constant Field Values

PNAME_LovButton

static final java.lang.String PNAME_LovButton
See Also:
Constant Field Values

PNAME_ComboBox

static final java.lang.String PNAME_ComboBox
See Also:
Constant Field Values

PNAME_ButtonGroup

static final java.lang.String PNAME_ButtonGroup
See Also:
Constant Field Values

PNAME_EnumList

static final java.lang.String PNAME_EnumList
See Also:
Constant Field Values
Method Detail

getLabel

java.lang.String getLabel(LocaleContext locale)
Retrieves the label to be used in any attribute prompts


getTooltip

java.lang.String getTooltip(LocaleContext locale)
Retrives the tooltip text to be used for this attribute


getDisplayHint

java.lang.String getDisplayHint(LocaleContext locale)
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";


getControlType

int getControlType(LocaleContext locale)
Returns the preferred control type for this attribute


getDisplayWidth

int getDisplayWidth(LocaleContext locale)
Returns the display width for this attribute


getDisplayHeight

int getDisplayHeight(LocaleContext locale)
Returns the display width for this attribute


getHint

java.lang.String getHint(LocaleContext locale,
                         java.lang.String sHintName)
Return defaulted hint value based on the hint name


getHintValue

java.lang.String getHintValue(LocaleContext locale,
                              java.lang.String sHintName)
Return hint value based on the hint name


hasFormatInformation

boolean hasFormatInformation(LocaleContext locale)
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.


getFormattedAttribute

java.lang.String getFormattedAttribute(AttributeList attrList,
                                       LocaleContext locale)
Returns the formatted value for the attribute. The AttributeList parameter will usually be an instance of the oracle.jbo.Row class.


parseFormattedAttribute

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.


displayInShortForm

boolean displayInShortForm(LocaleContext locale)
Returns true if the attribute is to displayed in the short(summary) form.


getFormat

java.lang.String getFormat(LocaleContext locale)
returns the format string stored in the ui hints


getFormatter

Formatter getFormatter(LocaleContext locale)
returns the formatter object stored in the ui hints


getFormatterClassName

java.lang.String getFormatterClassName(LocaleContext locale)
returns the formatter class stored in the ui hints


getLocaleName

java.lang.String getLocaleName(LocaleContext locale,
                               java.lang.String sName)
function for retrieving the locale name of a hint


getCompOpers

java.lang.String[][] getCompOpers(LocaleContext locale)
Returns a Map of operators for this attribute.


Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.0.0)

E10653-01

Copyright © 1997, 2008, Oracle. All rights reserved.