oracle.adf.view.faces.bi.component.chart

Class UILegend

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.chart.UILegend

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

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

Defines properties for the chart legend.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	MAXIMUM_SIZE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	POSITION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	REFERENCE_OBJECT_TITLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCROLLING_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SIZE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SYMBOL_HEIGHT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SYMBOL_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TITLE_H_ALIGN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TITLE_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

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

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UILegend()

Method Summary

Modifier and Type	Method and Description
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.Object	getMaximumSize() Returns the maximum legend size.
java.lang.String	getPosition() Returns the position of the legend within the chart.
java.lang.String	getReferenceObjectTitle() Returns the title for the reference object section of the legend, if present.
java.lang.String	getRendererType()
java.lang.String	getScrolling() Returns whether scrolling is enabled for the legend.
java.lang.Object	getSize() Returns the legend size.
java.lang.Number	getSymbolHeight() Returns the height of the legend symbol in pixels.
java.lang.Number	getSymbolWidth() Returns the width of the legend symbol in pixels.
java.lang.String	getTitle() Returns the title for the chart legend.
java.lang.String	getTitleHAlign() Returns the horizontal alignment for the legend title.
void	setMaximumSize(java.lang.Object size) Specifies the maximum legend size.
void	setPosition(java.lang.String position) Specifies the position of the legend within the chart.
void	setReferenceObjectTitle(java.lang.String title) Specifies the title for the reference object section of the legend, if present.
void	setScrolling(java.lang.String scrolling) Specifies whether scrolling is enabled for the legend.
void	setSize(java.lang.Object size) Specifies the legend size.
void	setSymbolHeight(java.lang.Number value) Specifies the height the legend symbol in pixels.
void	setSymbolWidth(java.lang.Number value) Specifies the width the legend symbol in pixels.
void	setTitle(java.lang.String title) Specifies the title for the chart legend.
void	setTitleHAlign(java.lang.String align) Specifies the horizontal alignment for the legend title.

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

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

addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

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

MAXIMUM_SIZE_KEY

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

POSITION_KEY

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

REFERENCE_OBJECT_TITLE_KEY

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

SCROLLING_KEY

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

SIZE_KEY

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

SYMBOL_HEIGHT_KEY

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

SYMBOL_WIDTH_KEY

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

TITLE_KEY

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

TITLE_H_ALIGN_KEY

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

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

Constructor Detail

UILegend

public UILegend()

Method Detail

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

getBeanType

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

Overrides:

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

getMaximumSize

public final java.lang.Object getMaximumSize()

Returns the maximum legend size.

setMaximumSize

public final void setMaximumSize(java.lang.Object size)

Specifies the maximum legend size.

getPosition

public final java.lang.String getPosition()

Returns the position of the legend within the chart. By default, the legend will be placed on the side or bottom, based on the size of the chart and the legend contents. Valid values are: auto (default), start, end, bottom, top.

setPosition

public final void setPosition(java.lang.String position)

Specifies the position of the legend within the chart. By default, the legend will be placed on the side or bottom, based on the size of the chart and the legend contents. Valid values are: auto (default), start, end, bottom, top.

getReferenceObjectTitle

public final java.lang.String getReferenceObjectTitle()

Returns the title for the reference object section of the legend, if present.

setReferenceObjectTitle

public final void setReferenceObjectTitle(java.lang.String title)

Specifies the title for the reference object section of the legend, if present.

getScrolling

public final java.lang.String getScrolling()

Returns whether scrolling is enabled for the legend. Valid values are "asNeeded" (default) and "off".

setScrolling

public final void setScrolling(java.lang.String scrolling)

Specifies whether scrolling is enabled for the legend. Valid values are "asNeeded" (default) and "off".

getSize

public final java.lang.Object getSize()

Returns the legend size.

setSize

public final void setSize(java.lang.Object size)

Specifies the legend size.

getSymbolWidth

public final java.lang.Number getSymbolWidth()

Returns the width of the legend symbol in pixels.

setSymbolWidth

public final void setSymbolWidth(java.lang.Number value)

Specifies the width the legend symbol in pixels.

getSymbolHeight

public final java.lang.Number getSymbolHeight()

Returns the height of the legend symbol in pixels.

setSymbolHeight

public final void setSymbolHeight(java.lang.Number value)

Specifies the height the legend symbol in pixels.

getTitle

public final java.lang.String getTitle()

Returns the title for the chart legend.

setTitle

public final void setTitle(java.lang.String title)

Specifies the title for the chart legend.

getTitleHAlign

public final java.lang.String getTitleHAlign()

Returns the horizontal alignment for the legend title. Valid values are:

• start - (default) aligned to the left in left-to-right mode, aligned to the right in to right-to-left mode
• center - positioned in the center
• end - aligned to the right in left-to-right mode, aligned to the left in right-to-left mode

setTitleHAlign

public final void setTitleHAlign(java.lang.String align)

Specifies the horizontal alignment for the legend title. Valid values are:

• start - (default) aligned to the left in left-to-right mode, aligned to the right in to right-to-left mode
• center - positioned in the center
• end - aligned to the right in left-to-right mode, aligned to the left in right-to-left mode