oracle.adf.view.faces.bi.component.pictoChart

Class UIPictoChartItem

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.pictoChart.UIPictoChartItem

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 UIPictoChartItem
extends org.apache.myfaces.trinidad.component.UIXComponentBase

Defines properties for a data item of a picto chart.

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	BORDER_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	BORDER_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLUMN_SPAN_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	COUNT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DRILLING_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NAME_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_SPAN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHAPE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SOURCE_HOVER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SOURCE_HOVER_SELECTED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SOURCE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SOURCE_SELECTED_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
UIPictoChartItem()

Method Summary

Modifier and Type	Method and Description
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.awt.Color	getBorderColor() Returns the border color of the data item.
java.lang.Number	getBorderWidth() Returns the border width of the data item.
java.awt.Color	getColor() Returns the fill color of the data item.
java.lang.Number	getColumnSpan() Returns the number of columns each shape (or custom image) spans.
java.lang.Number	getCount() Returns the number of times that the shape (or custom image) is drawn.
java.lang.String	getDrilling() Returns whether this item can be drilled.
java.lang.String	getFamily()
java.lang.String	getName() Returns the name of the data item.
java.lang.String	getRendererType()
java.lang.Number	getRowSpan() Returns the number of rows each shape (or custom image) spans.
java.lang.String	getShape() Returns the shape of the item.
java.lang.String	getShortDesc() Returns the description of the data item.
java.lang.String	getSource() Returns the URI of the custom image.
java.lang.String	getSourceHover() Returns the optional URI for the hover state.
java.lang.String	getSourceHoverSelected() Returns the optional URI for the hover selected state.
java.lang.String	getSourceSelected() Returns the optional URI for the selected state.
void	setBorderColor(java.awt.Color color) Specifies the border color of the data item.
void	setBorderWidth(java.lang.Number width) Specifies the border width of the data item.
void	setColor(java.awt.Color color) Specifies the fill color of the data item.
void	setColumnSpan(java.lang.Number span) Specifies the number of columns each shape (or custom image) spans.
void	setCount(java.lang.Number count) Specifies the number of times that the shape (or custom image) is drawn.
void	setDrilling(java.lang.String drilling) Specifies whether this item can be drilled.
void	setName(java.lang.String name) Specifies the name of the data item.
void	setRowSpan(java.lang.Number span) Specifies the number of rows each shape (or custom image) spans.
void	setShape(java.lang.String shape) Specifies the shape of the item.
void	setShortDesc(java.lang.String shortDesc) Specifies the description of the data item.
void	setSource(java.lang.String source) Specifies the URI of the custom image.
void	setSourceHover(java.lang.String source) Specifies the optional URI for the hover selected state.
void	setSourceHoverSelected(java.lang.String source) Specifies the optional URI for the hover state.
void	setSourceSelected(java.lang.String source) Specifies the optional URI for the selected state.

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

BORDER_COLOR_KEY

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

BORDER_WIDTH_KEY

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

COLOR_KEY

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

COLUMN_SPAN_KEY

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

COUNT_KEY

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

DRILLING_KEY

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

NAME_KEY

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

ROW_SPAN_KEY

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

SHAPE_KEY

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

SHORT_DESC_KEY

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

SOURCE_KEY

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

SOURCE_HOVER_KEY

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

SOURCE_HOVER_SELECTED_KEY

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

SOURCE_SELECTED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SOURCE_SELECTED_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

UIPictoChartItem

public UIPictoChartItem()

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

getBorderColor

public final java.awt.Color getBorderColor()

Returns the border color of the data item.

setBorderColor

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

Specifies the border color of the data item.

getBorderWidth

public final java.lang.Number getBorderWidth()

Returns the border width of the data item.

setBorderWidth

public final void setBorderWidth(java.lang.Number width)

Specifies the border width of the data item.

getColor

public final java.awt.Color getColor()

Returns the fill color of the data item.

setColor

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

Specifies the fill color of the data item.

getColumnSpan

public final java.lang.Number getColumnSpan()

Returns the number of columns each shape (or custom image) spans. Used for creating a pictoChart with mixed item sizes.

setColumnSpan

public final void setColumnSpan(java.lang.Number span)

Specifies the number of columns each shape (or custom image) spans. Used for creating a pictoChart with mixed item sizes.

getCount

public final java.lang.Number getCount()

Returns the number of times that the shape (or custom image) is drawn.

setCount

public final void setCount(java.lang.Number count)

Specifies the number of times that the shape (or custom image) is drawn.

getDrilling

public final java.lang.String getDrilling()

Returns whether this item can be drilled. Valid values are 'inherit' (default), 'off' and 'on'. When enabled, a drill event will be fired when the user clicks/taps on a the item.

setDrilling

public final void setDrilling(java.lang.String drilling)

Specifies whether this item can be drilled. Valid values are 'inherit' (default), 'off' and 'on'. When enabled, a drill event will be fired when the user clicks/taps on a the item.

getName

public final java.lang.String getName()

Returns the name of the data item.

setName

public final void setName(java.lang.String name)

Specifies the name of the data item.

getRowSpan

public final java.lang.Number getRowSpan()

Returns the number of rows each shape (or custom image) spans. Used for creating a pictoChart with mixed item sizes.

setRowSpan

public final void setRowSpan(java.lang.Number span)

Specifies the number of rows each shape (or custom image) spans. Used for creating a pictoChart with mixed item sizes.

getShape

public final java.lang.String getShape()

Returns the shape of the item. Does not apply if custom image is specified. Valid values are "rectangle"(default), "square", "circle", "diamond", "triangleUp", "triangleDown", "star", "plus", and "human".

setShape

public final void setShape(java.lang.String shape)

Specifies the shape of the item. Does not apply if custom image is specified. Valid values are "rectangle"(default), "square", "circle", "diamond", "triangleUp", "triangleDown", "star", "plus", and "human".

getShortDesc

public final java.lang.String getShortDesc()

Returns the description of the data item. This is used for accessibility and also for customizing the tooltip text. If this value is not specified, the default tooltip text will be used for accessibility.

setShortDesc

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

Specifies the description of the data item. This is used for accessibility and also for customizing the tooltip text. If this value is not specified, the default tooltip text will be used for accessibility.

getSource

public final java.lang.String getSource()

Returns the URI of the custom image. If specified, it takes precedence over shape.

setSource

public final void setSource(java.lang.String source)

Specifies the URI of the custom image. If specified, it takes precedence over shape.

getSourceHover

public final java.lang.String getSourceHover()

Returns the optional URI for the hover state. If not specified, the source image will be used.

setSourceHover

public final void setSourceHover(java.lang.String source)

Specifies the optional URI for the hover selected state. If not specified, the source image will be used.

getSourceHoverSelected

public final java.lang.String getSourceHoverSelected()

Returns the optional URI for the hover selected state. If not specified, the source image will be used.

setSourceHoverSelected

public final void setSourceHoverSelected(java.lang.String source)

Specifies the optional URI for the hover state. If not specified, the source image will be used.

getSourceSelected

public final java.lang.String getSourceSelected()

Returns the optional URI for the selected state. If not specified, the source image will be used.

setSourceSelected

public final void setSourceSelected(java.lang.String source)

Specifies the optional URI for the selected state. If not specified, the source image will be used.