oracle.adf.view.faces.bi.component.sunburst

Class UISunburstNode

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.sunburst.UISunburstNode

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

A child of the Sunburst component. The sunburst node displays two dimensions of data through its size and color.

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	_TEMPLATE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	DRILLING_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FILL_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FILL_PATTERN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_DISPLAY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_H_ALIGN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	RADIUS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTABLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VALUE_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

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
UISunburstNode() Constructs an instance of UISunburstNode.

Method Summary

Modifier and Type	Method and Description
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getDrilling() Returns the type of drilling enabled on this node.
java.lang.String	getFamily()
java.awt.Color	getFillColor() Returns the fill color of this area.
java.lang.String	getFillPattern() Returns the built-in pattern used to fill this node.
java.lang.String	getLabel() Returns the label for this node.
java.lang.String	getLabelDisplay() Returns the label display behavior for leaf nodes.
java.lang.String	getLabelHAlign() Returns the label alignment.
java.lang.String	getLabelStyle() Returns the font style for labels displayed within this node.
java.lang.Number	getRadius() Returns the radius for the node.
java.lang.String	getRendererType()
java.lang.String	getSelectable() Specifies whether or not the node will be selectable.
java.lang.String	getShortDesc() Returns the short description of this component.
java.lang.Number	getValue() Returns the value of this sunburst node.
void	setDrilling(java.lang.String drilling) Specifies the type of drilling enabled on this node.
void	setFillColor(java.awt.Color fillColor) Sets the fill color of this area.
void	setFillPattern(java.lang.String pattern) Specifies the built-in pattern used to fill this node.
void	setLabel(java.lang.String text) Specifies the label for this node.
void	setLabelDisplay(java.lang.String labelDisplay) Specifies the label display behavior for leaf nodes.
void	setLabelHAlign(java.lang.String labelHalign) Specifies the label alignment.
void	setLabelStyle(java.lang.String labelStyle) Sets the font style for labels displayed within this node.
void	setRadius(java.lang.Number radius) Specifies the radius of the node relative to the other nodes.
void	setSelectable(java.lang.String selectable) Returns whether or not the node will be selectable.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of this component.
void	setValue(java.lang.Number value) Sets the value of this sunburst node.

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

VALUE_KEY

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

SHORT_DESC_KEY

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

FILL_COLOR_KEY

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

FILL_PATTERN_KEY

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

LABEL_KEY

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

LABEL_DISPLAY_KEY

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

LABEL_H_ALIGN_KEY

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

LABEL_STYLE_KEY

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

DRILLING_KEY

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

RADIUS_KEY

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

SELECTABLE_KEY

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

CLIENT_LISTENERS_KEY

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

_TEMPLATE_KEY

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

UISunburstNode

public UISunburstNode()

Constructs an instance of UISunburstNode.

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

getValue

public final java.lang.Number getValue()

Returns the value of this sunburst node. This value determines the relative size of the node.

Returns:

the value of the component

setValue

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

Sets the value of this sunburst node. This value determines the relative size of the node.

Parameters:

value - the value of the component

getShortDesc

public final java.lang.String getShortDesc()

Returns the short description of this component. This is used to customize the tooltip text.

Returns:

the short description of this component

setShortDesc

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

Sets the short description of this component. This is used to customize the tooltip text.

Parameters:

shortDesc - the short description of this component

getFillColor

public final java.awt.Color getFillColor()

Returns the fill color of this area.

Returns:

the fill color of this area

setFillColor

public final void setFillColor(java.awt.Color fillColor)

Sets the fill color of this area.

Parameters:

fillColor - the fill color of this area

getFillPattern

public final java.lang.String getFillPattern()

Returns the built-in pattern used to fill this node. Valid values are:

• none
• smallChecker
• smallCrosshatch
• smallDiagonalLeft
• smallDiagonalRight
• smallDiamond
• smallTriangle
• largeChecker
• largeCrosshatch
• largeDiagonalLeft
• largeDiagonalRight
• largeDiamond
• largeTriangle

The pattern is drawn with a white background, and the foreground color is taken from the fillColor attribute.

Returns:

the pattern used to fill the area

setFillPattern

public final void setFillPattern(java.lang.String pattern)

Specifies the built-in pattern used to fill this node. Valid values are:

• none
• smallChecker
• smallCrosshatch
• smallDiagonalLeft
• smallDiagonalRight
• smallDiamond
• smallTriangle
• largeChecker
• largeCrosshatch
• largeDiagonalLeft
• largeDiagonalRight
• largeDiamond
• largeTriangle

The pattern is drawn with a white background, and the foreground color is taken from the fillColor attribute.

Parameters:

pattern - the pattern used to fill the area

getLabelDisplay

public final java.lang.String getLabelDisplay()

Returns the label display behavior for leaf nodes. Valid values are:

• auto - (Default) Display horizontal or rotated labels based on the client environment.
• horizontal - Display horizontal labels within the nodes
• rotated - Display rotated labels within the nodes
• off - Do not display the label

More labels are generally displayed when using rotation, at the cost of readability. Rotated labels are only supported in environments where rotated text is available. If rotated text is not available, labels will be displayed horizontally instead.

Returns:

the label display behavior for leaf nodes

setLabelDisplay

public final void setLabelDisplay(java.lang.String labelDisplay)

Specifies the label display behavior for leaf nodes. Valid values are:

• auto - (Default) Display horizontal or rotated labels based on the client environment.
• horizontal - Display horizontal labels within the nodes
• rotated - Display rotated labels within the nodes
• off - Do not display the label

More labels are generally displayed when using rotation, at the cost of readability. Rotated labels are only supported in environments where rotated text is available. If rotated text is not available, labels will be displayed horizontally instead.

Parameters:

labelDisplay - the label display behavior for leaf nodes

getLabelHAlign

public final java.lang.String getLabelHAlign()

Returns the label alignment. Valid values are:

• inner - Align to inner side of the node
• outer - Align to outer side of the node
• center - (Default) Center alignment

Returns:

the label alignment

setLabelHAlign

public final void setLabelHAlign(java.lang.String labelHalign)

Specifies the label alignment. Valid values are:

• inner - Align to inner side of the node
• outer - Align to outer side of the node
• center - (Default) Center alignment

Parameters:

labelHalign - the label alignment

getLabelStyle

public final java.lang.String getLabelStyle()

Returns the font style for labels displayed within this node. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.

Returns:

the font style for labels displayed within this node

setLabelStyle

public final void setLabelStyle(java.lang.String labelStyle)

Sets the font style for labels displayed within this node. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.

Parameters:

labelStyle - the font style for labels displayed within this node

getLabel

public final java.lang.String getLabel()

Returns the label for this node.

Returns:

the label for this node

setLabel

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

Specifies the label for this node.

Parameters:

text - the label for this node

getDrilling

public final java.lang.String getDrilling()

Returns the type of drilling enabled on this node. Valid values are:

• off - (Default) Do not enable drilling
• insert - Drill insert is enabled
• replace - Drill replace is enabled
• insertAndReplace - Both drill insert and drill replace are enabled

Returns:

the drilling type

setDrilling

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

Specifies the type of drilling enabled on this node. Valid values are:

• off - (Default) Do not enable drilling
• insert - Drill insert is enabled
• replace - Drill replace is enabled
• insertAndReplace - Both drill insert and drill replace are enabled

Parameters:

drilling - the drilling type

getRadius

public final java.lang.Number getRadius()

Returns the radius for the node. The default value is 1 and any number is accepted. The subtree with the largest total radius will be assigned the total radius of the sunburst.

Returns:

the label alignment

setRadius

public final void setRadius(java.lang.Number radius)

Specifies the radius of the node relative to the other nodes. The subtree with the largest total radius will be assigned the total radius of the sunburst. The default value is 1 and any number is accepted.

Parameters:

radius - the radius of the node relative to the other nodes.

getSelectable

public final java.lang.String getSelectable()

Specifies whether or not the node will be selectable. Valid values are:

• auto - (Default) Node will selectable if nodeSelection is enabled on the parent component
• off - Node will not be selectable

Returns:

the selectability setting for this node

setSelectable

public final void setSelectable(java.lang.String selectable)

Returns whether or not the node will be selectable. Valid values are:

• auto - (Default) Node will selectable if nodeSelection is enabled on the parent component
• off - Node will not be selectable

Parameters:

selectable - the selectability setting for this node