oracle.adf.view.faces.bi.component.common

Class UIReferenceObjectBase

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.common.UIReferenceObjectBase

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

Direct Known Subclasses:

UIReferenceArea, UIReferenceLine

public abstract class UIReferenceObjectBase
extends org.apache.myfaces.trinidad.component.UIXComponentBase

Defines properties for a reference object of a data visualization component.

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 org.apache.myfaces.trinidad.bean.PropertyKey	COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_IN_LEGEND_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LOCATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TEXT_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
UIReferenceObjectBase()

Method Summary

Modifier and Type	Method and Description
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getColor() Returns the fill color of the reference object.
java.lang.String	getDisplayInLegend() Returns whether the reference object is displayed in the legend, if a legend is present.
java.lang.String	getLocation() Returns the location of the reference object relative to the data items.
java.lang.String	getShortDesc() Returns the description of this object.
java.lang.String	getText() Returns the text displayed in the legend for the reference object.
void	setColor(java.awt.Color color) Specifies the fill color of the reference object.
void	setDisplayInLegend(java.lang.String displayInLegend) Specifies whether the reference object is displayed in the legend, if a legend is present.
void	setLocation(java.lang.String location) Specifies the location of the reference object relative to the data items.
void	setShortDesc(java.lang.String shortDesc) Specifies the description of this object.
void	setText(java.lang.String text) Specifies the text displayed in the legend for the reference object.

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, getFamily, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, 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, 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

COLOR_KEY

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

DISPLAY_IN_LEGEND_KEY

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

LOCATION_KEY

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

SHORT_DESC_KEY

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

TEXT_KEY

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

Constructor Detail

UIReferenceObjectBase

public UIReferenceObjectBase()

Method Detail

getBeanType

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

Overrides:

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

getColor

public final java.awt.Color getColor()

Returns the fill color of the reference object.

setColor

public final void setColor(java.awt.Color color)

Specifies the fill color of the reference object.

getDisplayInLegend

public final java.lang.String getDisplayInLegend()

Returns whether the reference object is displayed in the legend, if a legend is present. Valid values are "off" (default) and "on".

setDisplayInLegend

public final void setDisplayInLegend(java.lang.String displayInLegend)

Specifies whether the reference object is displayed in the legend, if a legend is present. Valid values are "off" (default) and "on".

getLocation

public final java.lang.String getLocation()

Returns the location of the reference object relative to the data items. Valid values are "back" (default) and "front". Gauge reference lines are always displayed in front, regardless of the value of this attribute.

setLocation

public final void setLocation(java.lang.String location)

Specifies the location of the reference object relative to the data items. Valid values are "back" (default) and "front". Gauge reference lines are always displayed in front, regardless of the value of this attribute.

getShortDesc

public final java.lang.String getShortDesc()

Returns the description of this object. This is used in charts for accessibility and also for customizing the tooltip text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Specifies the description of this object. This is used in charts for accessibility and also for customizing the tooltip text.

getText

public final java.lang.String getText()

Returns the text displayed in the legend for the reference object.

setText

public final void setText(java.lang.String text)

Specifies the text displayed in the legend for the reference object.