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

java.lang.Object
  javax.faces.component.UIComponent
      org.apache.myfaces.trinidad.component.UIXComponent
          org.apache.myfaces.trinidad.component.UIXComponentBase
              org.apache.myfaces.trinidad.component.UIXCollection
                  org.apache.myfaces.trinidad.component.UIXHierarchy
                      oracle.adf.view.faces.bi.component.sunburst.UISunburst

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, oracle.adf.view.rich.dnd.DragSourceFactory, org.apache.myfaces.trinidad.component.CollectionComponent, org.apache.myfaces.trinidad.model.LocalRowKeyIndex, org.apache.myfaces.trinidad.model.RowKeyIndex, org.apache.myfaces.trinidad.model.TreeLocalRowKeyIndex

public class UISunburst
extends org.apache.myfaces.trinidad.component.UIXHierarchy
implements oracle.adf.view.rich.dnd.DragSourceFactory

Sunbursts are used to display hierarchical data across two dimensions, represented by the size and color of the sunburst nodes.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex

org.apache.myfaces.trinidad.model.LocalRowKeyIndex.Confidence, org.apache.myfaces.trinidad.model.LocalRowKeyIndex.LocalCachingStrategy

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATION_DURATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATION_ON_DATA_CHANGE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATION_ON_DISPLAY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLOR_LABEL_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_DELIVERY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISCLOSED_ROW_KEYS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_LEVELS_CHILDREN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DRILL_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EMPTY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	GROUP_GAPS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LEGEND_SOURCE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NODE_SELECTION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	OTHER_COLOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	OTHER_PATTERN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	OTHER_THRESHOLD_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROOT_ROW_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROTATION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTED_ROW_KEYS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTION_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SIZE_LABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SORTING_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	START_ANGLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SUMMARY_KEY
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	VAR_STATUS_KEY

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

VAR_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

Fields inherited from interface oracle.adf.view.rich.dnd.DragSourceFactory

DEFAULT_DRAGSOURCE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UISunburst()
Constructs an instance of the UISunburst.

Method Summary

void	addDrillListener(DrillReplaceListener listener) Adds a drill listener.
void	addSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener) Adds a selection listener.
void	broadcast(javax.faces.event.FacesEvent event)
oracle.adf.view.rich.dnd.DragSource	createDragSource(java.lang.String name, java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions, oracle.adf.view.rich.dnd.DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties)
java.lang.CharSequence	createDragSourceBehavior(java.lang.String name, oracle.adf.view.rich.dnd.DragSource dragSource, java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions, oracle.adf.view.rich.dnd.DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties)
int	getAnimationDuration() Returns the animation duration in milliseconds.
java.lang.String	getAnimationOnDataChange() Returns the type of animation to apply on data change.
java.lang.String	getAnimationOnDisplay() Returns the type of animation to apply when the component is initially displayed.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getColorLabel() Returns the label describing the color metric of the component.
java.lang.String	getContentDelivery() Gets whether data should be fetched when the component is rendered initially.
java.lang.Object	getCurrentRowData() Get the row data object for the current row.
org.apache.myfaces.trinidad.model.RowKeySet	getDisclosedRowKeys() Gets the set of disclosed rows for this component.
int	getDisplayLevelsChildren() Gets the number of child levels to display during initial render.
java.lang.String[]	getDontPersist() Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
javax.el.MethodExpression	getDrillListener() Gets a method reference to a drill listener
DrillReplaceListener[]	getDrillListeners() Returns an array of attached drill listeners.
java.lang.String	getEmptyText() Retrieves the text of an empty component.
java.lang.String	getFamily()
java.lang.Object	getFocusRowKey()
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String	getLegendSource() Returns the id of the UIAttributeGroups used for display in the legend.
java.lang.String	getNodeSelection() Gets the selection mode.
javax.el.MethodExpression	getOtherColor() Returns a reference to the method that takes the RowKeySet of all nodes contained within the current "Other" node and returns a String for the color of that "Other" node.
javax.el.MethodExpression	getOtherPattern() Returns a reference to the method that takes the RowKeySet of all nodes contained within the current "Other" node and returns a String for the pattern of that "Other" node.
java.lang.Number	getOtherThreshold() Returns the percentage of the parent under which a node would be aggregated into an "Other" node.
java.lang.String[]	getPartialTriggers() Retrieves the ids of the partial triggers for the component.
java.lang.String[]	getPersist() Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager".
org.apache.myfaces.trinidad.model.RowKeySet	getPopupContext() Returns the RowKeySet providing context for a popup.
java.lang.String	getRendererType()
java.lang.Object	getRootRowKey() Returns the rowKey of the root of the component, if different than the root of the model.
java.lang.String	getRotation() Returns "on" (default) if client side rotation is enabled.
org.apache.myfaces.trinidad.model.RowKeySet	getSelectedRowKeys() Gets the selection state for this component.
javax.el.MethodExpression	getSelectionListener() Gets a method reference to a selection listener
org.apache.myfaces.trinidad.event.SelectionListener[]	getSelectionListeners() Returns an array of attached selection listeners.
java.lang.String	getSizeLabel() Returns the label describing the size metric of the component.
java.lang.String	getSorting() Returns "on" if sorting of the nodes by size is enabled.
protected java.util.List<javax.faces.component.UIComponent>	getStamps()
java.lang.Number	getStartAngle() Returns the starting angle of the sunburst.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.lang.String	getSummary() Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.
java.lang.Object	getValue() Retrieves the model used for this component.
java.lang.String	getVarStatus()
boolean	invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback)
protected void	processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
void	removeDrillListener(DrillReplaceListener listener) Removes a drill listener.
void	removeSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener) Removes a selection listener.
void	saveToSessionChangeManager(java.lang.String attributeName, java.lang.Object attributeValue) For internal use only
void	setAnimationDuration(int animationDuration) Specifies the animation duration in milliseconds.
void	setAnimationOnDataChange(java.lang.String type) Specifies the type of animation to apply on data change.
void	setAnimationOnDisplay(java.lang.String type) Specifies the type of animation to apply when the component is initially displayed.
void	setColorLabel(java.lang.String label) Specifies the label describing the color metric of the component.
void	setContentDelivery(java.lang.String contentDelivery) Sets whether data should be fetched when the component is rendered initially.
void	setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys) Sets the set of disclosed rows for this component.
void	setDisplayLevelsChildren(int displayLevelsChildren) Sets the number of child levels to display during initial render.
void	setDontPersist(java.lang.String[] dontPersist) Sets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
void	setEmptyText(java.lang.String emptyText) Sets the text of an empty component.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setLegendSource(java.lang.String source) Specifies the id of the UIAttributeGroups used for display in the legend.
void	setListener(javax.el.MethodExpression listener) Specifies a method reference to a drill listener
void	setNodeSelection(java.lang.String nodeSelection) Sets the selection mode.
void	setOtherColor(javax.el.MethodExpression method) Specifies a reference to the method that takes the RowKeySet of all nodes contained within the current "Other" node and returns a String for the color of that "Other" node.
void	setOtherPattern(javax.el.MethodExpression method) Specifies a reference to the method that takes the RowKeySet of all nodes contained within the current "Other" node and returns a String for the pattern of that "Other" node.
void	setOtherThreshold(java.lang.Number value) Specifies the percentage of the parent under which a node would be aggregated into an "Other" node.
void	setPartialTriggers(java.lang.String[] ids) Specifies the ids of the partial triggers for the component.
void	setPersist(java.lang.String[] persist) Sets List of persistent attributes that are persisting to a registered "Persistent Change Manager".
void	setPopupContext(org.apache.myfaces.trinidad.model.RowKeySet set) Specifies the RowKeySet providing context for a popup.
void	setRootRowKey(java.lang.Object rootRowKey) Specifies the rowKey of the root of the component, if different than the root of the model.
void	setRotation(java.lang.String rotation) Specifies whether client side rotation is enabled.
void	setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet selectedRowKeys) Sets the selection state for this component.
void	setSelectionListener(javax.el.MethodExpression selectionListener) Sets a method reference to a selection listener
void	setSizeLabel(java.lang.String label) Specifies the label describing the size metric of the component.
void	setSorting(java.lang.String sorting) Specifies whether the nodes are sorted by size.
void	setStartAngle(java.lang.Number startAngle) Specifies the starting angle of the sunburst.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setSummary(java.lang.String summary) Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.
protected void	setupVisitingContext(javax.faces.context.FacesContext context)
void	setValue(java.lang.Object value) Specified the model for the component.
void	setVarStatus(java.lang.String varStatus) Sets the name of the EL variable used to reference the varStatus information.
protected void	tearDownVisitingContext(javax.faces.context.FacesContext context)

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

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, createCollectionModel, createVarStatusMap, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getTreeModel, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainer, isContainerEmpty

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

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setVar, updateChildrenImpl, validateChildrenImpl

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren

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

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, tearDownEncodingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.trinidad.component.CollectionComponent

getVar

Methods inherited from interface org.apache.myfaces.trinidad.model.RowKeyIndex

getRowCount, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, setRowIndex, setRowKey

Methods inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable

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

PARTIAL_TRIGGERS_KEY

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

CONTENT_DELIVERY_KEY

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

SUMMARY_KEY

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

EMPTY_TEXT_KEY

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

VAR_STATUS_KEY

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

ROOT_ROW_KEY_KEY

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

DRILL_LISTENER_KEY

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

SELECTED_ROW_KEYS_KEY

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

NODE_SELECTION_KEY

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

SELECTION_LISTENER_KEY

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

DISCLOSED_ROW_KEYS_KEY

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

DISPLAY_LEVELS_CHILDREN_KEY

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

GROUP_GAPS_KEY

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

ROTATION_KEY

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

SORTING_KEY

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

START_ANGLE_KEY

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

ANIMATION_DURATION_KEY

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

ANIMATION_ON_DATA_CHANGE_KEY

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

ANIMATION_ON_DISPLAY_KEY

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

LEGEND_SOURCE_KEY

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

SIZE_LABEL_KEY

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

COLOR_LABEL_KEY

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

OTHER_THRESHOLD_KEY

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

OTHER_COLOR_KEY

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

OTHER_PATTERN_KEY

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

CLIENT_LISTENERS_KEY

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

UISunburst

public UISunburst()

Constructs an instance of the UISunburst.

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

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

getSummary

public final java.lang.String getSummary()

Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.

Returns:

the new summary value

setSummary

public final void setSummary(java.lang.String summary)

Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.

Parameters:

summary - the new summary value

getEmptyText

public final java.lang.String getEmptyText()

Retrieves the text of an empty component. If the text is enclosed in an html tag, it will be formatted. The formatting behavior is similar to outputFormatted component.

Returns:

the text to show in an empty component

setEmptyText

public final void setEmptyText(java.lang.String emptyText)

Sets the text of an empty component. If the text is enclosed in an html tag, it will be formatted. The formatting behavior is similar to outputFormatted component.

Parameters:

emptyText - the text to show in an empty component

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

getValue

public final java.lang.Object getValue()

Retrieves the model used for this component.

Specified by:

getValue in class org.apache.myfaces.trinidad.component.UIXCollection

Returns:

The model used for this component.

See Also:

setValue(java.lang.Object)

setValue

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

Specified the model for the component.

See Also:

getValue()

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] ids)

Specifies the ids of the partial triggers for the component.

Parameters:

ids - The ids of the partial trigger components for the component.

See Also:

getPartialTriggers()

getPartialTriggers

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

Retrieves the ids of the partial triggers for the component.

Returns:

ids The ids of the partial trigger components for the component.

See Also:

setPartialTriggers(java.lang.String[])

getContentDelivery

public final java.lang.String getContentDelivery()

Gets whether data should be fetched when the component is rendered initially. Options are "lazy", "immediate", and "whenAvailable". If "lazy", then the hierarchyViewer content is fetched after the hierarchyViewer is sent to the browser. If "immediate", then the hierarchyViewer content is immediately sent to the browser. If "whenAvailable", then "immediate" content delivery is used if the data is already available; otherwise "lazy" content delivery is used. The default value is "whenAvailable".

Returns:

the new contentDelivery value

setContentDelivery

public final void setContentDelivery(java.lang.String contentDelivery)

Sets whether data should be fetched when the component is rendered initially. Options are "lazy", "immediate", and "whenAvailable". If "lazy", then the hierarchyViewer content is fetched after the hierarchyViewer is sent to the browser. If "immediate", then the hierarchyViewer content is immediately sent to the browser. If "whenAvailable", then "immediate" content delivery is used if the data is already available; otherwise "lazy" content delivery is used. The default value is "whenAvailable".

Parameters:

contentDelivery - the new contentDelivery value

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 java.lang.String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

invokeOnComponent in class org.apache.myfaces.trinidad.component.UIXCollection

Throws:

javax.faces.FacesException

setupVisitingContext

protected void setupVisitingContext(javax.faces.context.FacesContext context)

Overrides:

setupVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

tearDownVisitingContext

protected void tearDownVisitingContext(javax.faces.context.FacesContext context)

Overrides:

tearDownVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

getCurrentRowData

public final java.lang.Object getCurrentRowData()

Get the row data object for the current row. This method returns the same object as getRowData().

Returns:

row data object for the current row

getPopupContext

public final org.apache.myfaces.trinidad.model.RowKeySet getPopupContext()

Returns the RowKeySet providing context for a popup. This API is only necessary when displaying popups for an "Other" node, which represents several row keys.

Returns:

setPopupContext

public final void setPopupContext(org.apache.myfaces.trinidad.model.RowKeySet set)

Specifies the RowKeySet providing context for a popup. This API is only necessary when displaying popups for an "Other" node, which represents several row keys.

Parameters:

set -

getNodeSelection

public final java.lang.String getNodeSelection()

Gets the selection mode. Valid values are: "none" - no nodes can be selected "single" - a single node can be selected "multiple" - multiple nodes can be selected

Returns:

the new nodeSelection value

setNodeSelection

public final void setNodeSelection(java.lang.String nodeSelection)

Sets the selection mode. Valid values are: "none" - no nodes can be selected "single" - a single node can be selected "multiple" - multiple nodes can be selected

Parameters:

nodeSelection - the new nodeSelection value

getFocusRowKey

public java.lang.Object getFocusRowKey()

Specified by:

getFocusRowKey in class org.apache.myfaces.trinidad.component.UIXHierarchy

getRootRowKey

public final java.lang.Object getRootRowKey()

Returns the rowKey of the root of the component, if different than the root of the model.

Returns:

setRootRowKey

public final void setRootRowKey(java.lang.Object rootRowKey)

Specifies the rowKey of the root of the component, if different than the root of the model.

Parameters:

rootRowKey - the new root of the component

getSelectedRowKeys

public final org.apache.myfaces.trinidad.model.RowKeySet getSelectedRowKeys()

Gets the selection state for this component.

Returns:

the new selectedRowKeys value

setSelectedRowKeys

public final void setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet selectedRowKeys)

Sets the selection state for this component.

Parameters:

selectedRowKeys - the new selectedRowKeys value

getVarStatus

public final java.lang.String getVarStatus()

Specified by:

getVarStatus in class org.apache.myfaces.trinidad.component.UIXCollection

setVarStatus

public final void setVarStatus(java.lang.String varStatus)

Sets the name of the EL variable used to reference the varStatus information.

Parameters:

varStatus -

getStamps

protected java.util.List<javax.faces.component.UIComponent> getStamps()

Overrides:

getStamps in class org.apache.myfaces.trinidad.component.UIXHierarchy

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXCollection

Throws:

javax.faces.event.AbortProcessingException

createDragSource

public oracle.adf.view.rich.dnd.DragSource createDragSource(java.lang.String name,
                                                            java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions,
                                                            oracle.adf.view.rich.dnd.DnDAction defaultAction,
                                                            java.lang.String discriminant,
                                                            javax.el.MethodExpression dragDropEndListener,
                                                            java.util.Map<java.lang.String,?> properties)

Specified by:

createDragSource in interface oracle.adf.view.rich.dnd.DragSourceFactory

createDragSourceBehavior

public java.lang.CharSequence createDragSourceBehavior(java.lang.String name,
                                                       oracle.adf.view.rich.dnd.DragSource dragSource,
                                                       java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions,
                                                       oracle.adf.view.rich.dnd.DnDAction defaultAction,
                                                       java.lang.String discriminant,
                                                       javax.el.MethodExpression dragDropEndListener,
                                                       java.util.Map<java.lang.String,?> properties)

Specified by:

createDragSourceBehavior in interface oracle.adf.view.rich.dnd.DragSourceFactory

getSelectionListener

public final javax.el.MethodExpression getSelectionListener()

Gets a method reference to a selection listener

Returns:

the new selectionListener value

setSelectionListener

public final void setSelectionListener(javax.el.MethodExpression selectionListener)

Sets a method reference to a selection listener

Parameters:

selectionListener - the new selectionListener value

getSelectionListeners

public final org.apache.myfaces.trinidad.event.SelectionListener[] getSelectionListeners()

Returns an array of attached selection listeners.

Returns:

an array of attached selection listeners.

addSelectionListener

public final void addSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener)

Adds a selection listener.

Parameters:

listener - the selection listener to add

removeSelectionListener

public final void removeSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener)

Removes a selection listener.

Parameters:

listener - the selection listener to remove

getDrillListener

public final javax.el.MethodExpression getDrillListener()

Gets a method reference to a drill listener

Returns:

the drill listener for this component

setListener

public final void setListener(javax.el.MethodExpression listener)

Specifies a method reference to a drill listener

Parameters:

listener - the drill listener for this component

getDrillListeners

public final DrillReplaceListener[] getDrillListeners()

Returns an array of attached drill listeners.

Returns:

an array of attached drill listeners.

addDrillListener

public final void addDrillListener(DrillReplaceListener listener)

Adds a drill listener.

Parameters:

listener - the drill listener to add

removeDrillListener

public final void removeDrillListener(DrillReplaceListener listener)

Removes a drill listener.

Parameters:

listener - the drill listener to remove

getDisclosedRowKeys

public final org.apache.myfaces.trinidad.model.RowKeySet getDisclosedRowKeys()

Gets the set of disclosed rows for this component. Each entry in the set is a rowKey.

Returns:

the new disclosedRowKeys value

setDisclosedRowKeys

public final void setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys)

Sets the set of disclosed rows for this component. Each entry in the set is a rowKey.

Parameters:

disclosedRowKeys - the new disclosedRowKeys value

getDisplayLevelsChildren

public final int getDisplayLevelsChildren()

Gets the number of child levels to display during initial render. This property is 0-based. A value of 0 means that no child levels below the root will be shown; the root itself will be shown. The default value is 2, which means that the root and the first two levels of children will be shown.

Returns:

the new displayLevelsChildren value

setDisplayLevelsChildren

public final void setDisplayLevelsChildren(int displayLevelsChildren)

Sets the number of child levels to display during initial render. This property is 0-based. A value of 0 means that no child levels below the root will be shown; the root itself will be shown. The default value is 2, which means that the root and the first two levels of children will be shown.

Parameters:

displayLevelsChildren - the new displayLevelsChildren value

getRotation

public final java.lang.String getRotation()

Returns "on" (default) if client side rotation is enabled. Returns "off" otherwise.

setRotation

public final void setRotation(java.lang.String rotation)

Specifies whether client side rotation is enabled. Valid values are "on" and "off" (default).

getSorting

public final java.lang.String getSorting()

Returns "on" if sorting of the nodes by size is enabled. Returns "off" (default) otherwise. When sorting is enabled, nodes that have the same parent are sorted in order of descending size.

setSorting

public final void setSorting(java.lang.String sorting)

Specifies whether the nodes are sorted by size. Valid values are "on" and "off" (default). When sorting is enabled, nodes that have the same parent are sorted in order of descending size.

getStartAngle

public final java.lang.Number getStartAngle()

Returns the starting angle of the sunburst. Valid values are numbers between 0 and 360, with a default of 90.

setStartAngle

public final void setStartAngle(java.lang.Number startAngle)

Specifies the starting angle of the sunburst. Valid values are numbers between 0 and 360, with a default of 90.

getAnimationDuration

public final int getAnimationDuration()

Returns the animation duration in milliseconds. For data change animations, which have multiple stages, this attribute defines the duration of each stage. For example, if an animation contains two stages, the total duration will be two times this attribute's value.

Returns:

the animation duration in milliseconds

setAnimationDuration

public final void setAnimationDuration(int animationDuration)

Specifies the animation duration in milliseconds. For data change animations, which have multiple stages, this attribute defines the duration of each stage. For example, if an animation contains two stages, the total duration will be two times this attribute's value.

Parameters:

animationDuration - the animation duration in milliseconds

getAnimationOnDataChange

public final java.lang.String getAnimationOnDataChange()

Returns the type of animation to apply on data change. Valid values for animating data objects are:

• none - Does not apply data change animation effects
• activeData - (Default) Applies animation for Active Data Service (ADS) data change events.
• auto - Applies animation for Partial Page Refresh and ADS events.

Animation can also be performed on the entire component, allowing for effects such as slideshow transitions. These animations will be performed on any Partial Page Refresh event, and valid values are:

• alphaFade
• flipLeft
• flipRight
• slideToLeft
• slideToRight
• transitionToLeft
• transitionToRight
• zoom

Returns:

the animation to apply on initial display

setAnimationOnDataChange

public final void setAnimationOnDataChange(java.lang.String type)

Specifies the type of animation to apply on data change. Valid values for animating data objects are:

• none - Does not apply data change animation effects
• activeData - (Default) Applies animation for Active Data Service (ADS) data change events.
• auto - Applies animation for Partial Page Refresh and ADS events.

Animation can also be performed on the entire component, allowing for effects such as slideshow transitions. These animations will be performed on any Partial Page Refresh event, and valid values are:

• alphaFade
• flipLeft
• flipRight
• slideToLeft
• slideToRight
• transitionToLeft
• transitionToRight
• zoom

Parameters:

type - the animation to apply on initial display

getAnimationOnDisplay

public final java.lang.String getAnimationOnDisplay()

Returns the type of animation to apply when the component is initially displayed. Valid values are:

• none - (Default) Does not apply any initial rendering effect
• alphaFade
• fan
• zoom

Returns:

the animation to apply on initial display

setAnimationOnDisplay

public final void setAnimationOnDisplay(java.lang.String type)

Specifies the type of animation to apply when the component is initially displayed. Valid values are:

• none - (Default) Does not apply any initial rendering effect
• alphaFade
• fan
• zoom

Parameters:

type - the animation to apply on initial display

getLegendSource

public final java.lang.String getLegendSource()

Returns the id of the UIAttributeGroups used for display in the legend. This UIAttributeGroups component must be a child of a node within this component.

setLegendSource

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

Specifies the id of the UIAttributeGroups used for display in the legend. This UIAttributeGroups component must be a child of a node within this component.

getSizeLabel

public final java.lang.String getSizeLabel()

Returns the label describing the size metric of the component.

setSizeLabel

public final void setSizeLabel(java.lang.String label)

Specifies the label describing the size metric of the component.

getColorLabel

public final java.lang.String getColorLabel()

Returns the label describing the color metric of the component.

setColorLabel

public final void setColorLabel(java.lang.String label)

Specifies the label describing the color metric of the component.

getOtherThreshold

public final java.lang.Number getOtherThreshold()

Returns the percentage of the parent under which a node would be aggregated into an "Other" node. Valid values range from 0 (default) to 1. For example, a value of 0.1 would cause all nodes which are less than 10% of their parent to be aggregated into the "Other" node.

setOtherThreshold

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

Specifies the percentage of the parent under which a node would be aggregated into an "Other" node. Valid values range from 0 (default) to 1. For example, a value of 0.1 would cause all nodes which are less than 10% of their parent to be aggregated into the "Other" node.

getOtherColor

public final javax.el.MethodExpression getOtherColor()

Returns a reference to the method that takes the RowKeySet of all nodes contained within the current "Other" node and returns a String for the color of that "Other" node.

setOtherColor

public final void setOtherColor(javax.el.MethodExpression method)

Specifies a reference to the method that takes the RowKeySet of all nodes contained within the current "Other" node and returns a String for the color of that "Other" node.

getOtherPattern

public final javax.el.MethodExpression getOtherPattern()

Returns a reference to the method that takes the RowKeySet of all nodes contained within the current "Other" node and returns a String for the pattern of that "Other" node.

setOtherPattern

public final void setOtherPattern(javax.el.MethodExpression method)

Specifies a reference to the method that takes the RowKeySet of all nodes contained within the current "Other" node and returns a String for the pattern of that "Other" node.

saveToSessionChangeManager

public void saveToSessionChangeManager(java.lang.String attributeName,
                                       java.lang.Object attributeValue)

For internal use only

processFacetsAndChildren

protected void processFacetsAndChildren(javax.faces.context.FacesContext context,
                                        javax.faces.event.PhaseId phaseId)

Specified by:

processFacetsAndChildren in class org.apache.myfaces.trinidad.component.UIXCollection