oracle.jbo
Interface AttributeHints

All Known Implementing Classes:

AttributeDefImpl, AttributeDefImpl, AttributeDefImpl, DomainAttributeDef

public interface AttributeHints

Defines access to an Attribute's user interface hints.

Since:

JDeveloper 9.0.2

See Also:

AttributeDef

Field Summary

static java.lang.String	ATTRIBUTE_CTL_DISPLAYHEIGHT
static java.lang.String	ATTRIBUTE_CTL_DISPLAYWIDTH
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 int	CTLTYPE_DATE
static int	CTLTYPE_DEFAULT
static int	CTLTYPE_EDIT
static int	CTLTYPE_IMAGE
static int	CTLTYPE_LIST
static int	CTLTYPE_LOV
static int	CTLTYPE_TOGGLE
static java.lang.String	FMT_FORMAT
static java.lang.String	FMT_FORMATTER

Method Summary

boolean	displayInShortForm(LocaleContext locale) Returns true if the attribute is to displayed in the short(summary) form.
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

public static final java.lang.String ATTRIBUTE_LABEL

See Also:

Constant Field Values

ATTRIBUTE_TOOLTIP

public static final java.lang.String ATTRIBUTE_TOOLTIP

See Also:

Constant Field Values

ATTRIBUTE_DISPLAY_HINT

public static final java.lang.String ATTRIBUTE_DISPLAY_HINT

See Also:

Constant Field Values

ATTRIBUTE_CTL_TYPE

public static final java.lang.String ATTRIBUTE_CTL_TYPE

See Also:

Constant Field Values

ATTRIBUTE_CTL_DISPLAYWIDTH

public static final java.lang.String ATTRIBUTE_CTL_DISPLAYWIDTH

See Also:

Constant Field Values

ATTRIBUTE_CTL_DISPLAYHEIGHT

public static final java.lang.String ATTRIBUTE_CTL_DISPLAYHEIGHT

See Also:

Constant Field Values

ATTRIBUTE_CTL_FORMTYPE

public static final java.lang.String ATTRIBUTE_CTL_FORMTYPE

See Also:

Constant Field Values

CTLTYPE_DEFAULT

public static final int CTLTYPE_DEFAULT

See Also:

Constant Field Values

CTLTYPE_EDIT

public static final int CTLTYPE_EDIT

See Also:

Constant Field Values

CTLTYPE_DATE

public static final int CTLTYPE_DATE

See Also:

Constant Field Values

CTLTYPE_TOGGLE

public static final int CTLTYPE_TOGGLE

See Also:

Constant Field Values

CTLTYPE_IMAGE

public static final int CTLTYPE_IMAGE

See Also:

Constant Field Values

CTLTYPE_LOV

public static final int CTLTYPE_LOV

See Also:

Constant Field Values

CTLTYPE_LIST

public static final int CTLTYPE_LIST

See Also:

Constant Field Values

ATTRIBUTE_DISPLAY_HINT_DISPLAY

public static final java.lang.String ATTRIBUTE_DISPLAY_HINT_DISPLAY

See Also:

Constant Field Values

ATTRIBUTE_DISPLAY_HINT_HIDE

public static final java.lang.String ATTRIBUTE_DISPLAY_HINT_HIDE

See Also:

Constant Field Values

ATTRIBUTE_FORM_TYPE_SHORT

public static final java.lang.String ATTRIBUTE_FORM_TYPE_SHORT

See Also:

Constant Field Values

ATTRIBUTE_FORM_TYPE_DETAIL

public static final java.lang.String ATTRIBUTE_FORM_TYPE_DETAIL

See Also:

Constant Field Values

FMT_FORMATTER

public static final java.lang.String FMT_FORMATTER

See Also:

Constant Field Values

FMT_FORMAT

public static final java.lang.String FMT_FORMAT

See Also:

Constant Field Values

Method Detail

getLabel

public java.lang.String getLabel(LocaleContext locale)

Retrieves the label to be used in any attribute prompts

getTooltip

public java.lang.String getTooltip(LocaleContext locale)

Retrives the tooltip text to be used for this attribute

getDisplayHint

public 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

public int getControlType(LocaleContext locale)

Returns the preferred control type for this attribute

getDisplayWidth

public int getDisplayWidth(LocaleContext locale)

Returns the display width for this attribute

getDisplayHeight

public int getDisplayHeight(LocaleContext locale)

Returns the display width for this attribute

getHint

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

Return defaulted hint value based on the hint name

getHintValue

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

Return hint value based on the hint name

hasFormatInformation

public 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

public 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

public 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

public boolean displayInShortForm(LocaleContext locale)

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

getFormat

public java.lang.String getFormat(LocaleContext locale)

returns the format string stored in the ui hints

getFormatter

public Formatter getFormatter(LocaleContext locale)

returns the formatter object stored in the ui hints

getFormatterClassName

public java.lang.String getFormatterClassName(LocaleContext locale)

returns the formatter class stored in the ui hints

getLocaleName

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

function for retrieving the locale name of a hint