oracle.apps.fnd.applcore.flex.runtime.util.common
Interface UIHints

All Known Implementing Classes:

SegmentDefImpl

public interface UIHints

Information for rendering the user interface.

Nested Class Summary

static class	UIHints.DisplayType The display type.
static class	UIHints.DisplayTypeProperty Properties of the display types defined by DisplayType.

Field Summary

static java.lang.String	CTL_DATE_TIME Control type for "date time".
static java.lang.String	CTL_TYPE_PREFIX The prefix to identify the control types defined in this class.

Method Summary

java.lang.String	getControlType() Gets the preferred UI control type
java.lang.String	getDescription() Gets the description.
UIHints.DisplayType	getDisplayType() Gets the preferred display type.
java.lang.Object	getDisplayTypeProperty(UIHints.DisplayTypeProperty name) Gets a property of a display type.
int	getDisplayWidth() Gets the display width.
java.lang.String	getLabel() Gets the label in the locale when this information is fetched.
java.lang.String	getTitle() Gets the title.
java.util.Map<java.lang.String,java.lang.String>	getTranslatedLabels() Gets translated labels for multiple languages.
boolean	isHidden() Returns true if the associated component should be hidden.
boolean	isReadOnly() Returns true if the segment is read-only.
boolean	isReferenced() Returns true if the associated component is referenced by other components.

Field Detail

CTL_TYPE_PREFIX

static final java.lang.String CTL_TYPE_PREFIX

The prefix to identify the control types defined in this class.

See Also:

Constant Field Values

CTL_DATE_TIME

static final java.lang.String CTL_DATE_TIME

Control type for "date time".

See Also:

Constant Field Values

Method Detail

getTitle

java.lang.String getTitle()

Gets the title.

Returns:

the title

getDescription

java.lang.String getDescription()

Gets the description.

Returns:

the description

getLabel

java.lang.String getLabel()

Gets the label in the locale when this information is fetched.

Returns:

the label

getTranslatedLabels

java.util.Map<java.lang.String,java.lang.String> getTranslatedLabels()

Gets translated labels for multiple languages. The keys are language codes and the values are labels in those languages.

Returns:

the translated labels for multiple languages; an empty map if no translated labels are available

getControlType

java.lang.String getControlType()

Gets the preferred UI control type

Returns:

the preferred control type

getDisplayType

UIHints.DisplayType getDisplayType()

Gets the preferred display type.

Returns:

the preferred display type

getDisplayTypeProperty

java.lang.Object getDisplayTypeProperty(UIHints.DisplayTypeProperty name)

Gets a property of a display type.

Parameters:

name - the property

Returns:

the property value

isHidden

boolean isHidden()

Returns true if the associated component should be hidden.

Returns:

true if the associated component should be hidden

getDisplayWidth

int getDisplayWidth()

Gets the display width.

Returns:

the display width

isReferenced

boolean isReferenced()

Returns true if the associated component is referenced by other components. In general, the UI of the associated component should post back the data changes as soon as possible if the component is updatable and referenced.

Returns:

true if the associated component is referenced by other components

isReadOnly

boolean isReadOnly()

Returns true if the segment is read-only.

Returns:

true if the segment is read-only