oracle.adf.view.faces.bi.component.gantt
Class Legend

java.lang.Object
  javax.faces.component.UIComponent
      org.apache.myfaces.trinidad.component.UIXComponent
          org.apache.myfaces.trinidad.component.UIXComponentBase
              oracle.adf.view.faces.bi.component.gantt.Legend

All Implemented Interfaces:

javax.faces.component.StateHolder

public class Legend
extends org.apache.myfaces.trinidad.component.UIXComponentBase

The Legend control must be used as a child of the Gantt control. It displays information about the currently selected task, as well as legend of icons and types of task bars displayed in the Gantt.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ICON_LABELS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ICONS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	KEYS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABELS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static java.lang.String	TIMEZONE_TOKEN
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

Legend()
Constructs an instance of the Legend.

Method Summary

protected void	addAttributeChange(java.lang.String attributeName, java.lang.Object attributeValue)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getCustomizationId() Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
java.lang.String[]	getDontPersist() Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
java.lang.String	getFamily()
java.lang.String[]	getIconLabels() Retrieves the label for the icons in the Legend.
java.lang.String[]	getIcons() Retrieves the path of the icons in the Legend.
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String[]	getKeys() Retrieves the data object keys used to populate the legend.
java.lang.String[]	getLabels() Retrieves the labels for the legend keys specified by the user.
java.lang.String[]	getPersist() Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager".
java.lang.String	getRendererType()
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.lang.Object	getValue() Retrieves the selected task rendered in the legend.
boolean	isVisible() Whether the legend is visible.
void	setCustomizationId(java.lang.String customizationId) Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
void	setDontPersist(java.lang.String[] dontPersist) Sets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
void	setIconLabels(java.lang.String[] labels) Specifies the label for the icons in the Legend.
void	setIcons(java.lang.String[] icons) Specifies the path of the icons to show in the Legend.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setKeys(java.lang.String[] keys) Specifies the data object keys used to populate the legend.
void	setLabels(java.lang.String[] labels) Specifies the labels for the legend keys specified by the user.
void	setPersist(java.lang.String[] persist) Sets List of persistent attributes that are persisting to a registered "Persistent Change Manager".
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setValue(java.lang.Object value) Specifies the selected task rendered in the legend.
void	setVisible(boolean visible) Specifies the visibility of the legend.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

getContainerClientId

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

VALUE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY

ICONS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ICONS_KEY

ICON_LABELS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_LABELS_KEY

KEYS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey KEYS_KEY

LABELS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABELS_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

CUSTOMIZATION_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

PERSIST_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY

DONT_PERSIST_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY

TIMEZONE_TOKEN

public static final java.lang.String TIMEZONE_TOKEN

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Constructor Detail

Legend

public Legend()

Constructs an instance of the Legend.

Method Detail

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getRendererType

public java.lang.String getRendererType()

Overrides:

getRendererType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component.

Parameters:

styleClass - the new styleClass value

getPersist

public final java.lang.String[] getPersist()

Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Returns:

the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)

Sets List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Parameters:

persist - the new persist value

getDontPersist

public final java.lang.String[] getDontPersist()

Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.

Returns:

the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)

Sets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.

Parameters:

dontPersist - the new dontPersist value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

getValue

public final java.lang.Object getValue()

Retrieves the selected task rendered in the legend.

Returns:

The selected task rendered in the legend.

See Also:

setValue(java.lang.Object)

setValue

public final void setValue(java.lang.Object value)

Specifies the selected task rendered in the legend.

Parameters:

value - The selected task rendered in the legend.

getIcons

public final java.lang.String[] getIcons()

Retrieves the path of the icons in the Legend.

Returns:

the path of the icons in the Legend.

setIcons

public final void setIcons(java.lang.String[] icons)

Specifies the path of the icons to show in the Legend.

Parameters:

icons - the path of the icons in the Legend.

getIconLabels

public final java.lang.String[] getIconLabels()

Retrieves the label for the icons in the Legend.

Returns:

the label for the icons in the Legend.

setIconLabels

public final void setIconLabels(java.lang.String[] labels)

Specifies the label for the icons in the Legend.

Parameters:

labels - the label for the icons in the Legend.

getKeys

public final java.lang.String[] getKeys()

Retrieves the data object keys used to populate the legend.

Returns:

The data object keys used to populate the legend.

See Also:

setKeys(java.lang.String[])

setKeys

public final void setKeys(java.lang.String[] keys)

Specifies the data object keys used to populate the legend.

Parameters:

keys - The data object keys used to populate the legend.

getLabels

public final java.lang.String[] getLabels()

Retrieves the labels for the legend keys specified by the user.

Returns:

The labels for the legend keys specified by the user.

See Also:

setLabels(java.lang.String[]), setKeys(java.lang.String[])

setLabels

public final void setLabels(java.lang.String[] labels)

Specifies the labels for the legend keys specified by the user.

Parameters:

labels - The labels for the legend keys.

See Also:

setKeys(java.lang.String[])

isVisible

public final boolean isVisible()

Whether the legend is visible.

Returns:

true if the legend is visible. false otherwise.

setVisible

public final void setVisible(boolean visible)

Specifies the visibility of the legend.

Parameters:

visible - true to set the legend visible. false otherwise.

addAttributeChange

protected void addAttributeChange(java.lang.String attributeName,
                                  java.lang.Object attributeValue)

Overrides:

addAttributeChange in class org.apache.myfaces.trinidad.component.UIXComponentBase