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:

java.util.EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, 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

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 class org.apache.myfaces.trinidad.component.UIXCollection

org.apache.myfaces.trinidad.component.UIXCollection.NoColumnFacetsVisitContext

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 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	EMPTY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FOCUS_ROW_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NODE_SELECTION_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	POPUP_CONTEXT_ROW_KEY_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	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

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UISunburst()
Constructs an instance of the UISunburst.

Method Summary

void	addSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener) Adds a selection listener.
void	broadcast(javax.faces.event.FacesEvent event)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getClientRowKey()
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".
java.lang.String	getEmptyText() Retrieves the text of an empty component.
java.lang.String	getFamily()
java.lang.Object	getFocusRowKey() Gets the rowKey of the currently focused row.
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String	getNodeSelection() Gets the selection mode.
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".
protected java.lang.Object	getPopupContextRowKey() For internal use only
java.lang.String	getRendererType()
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	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()
protected void	processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
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	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	setFocusRowKey(java.lang.Object focusRowKey) Sets the rowKey of the currently focused row.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setNodeSelection(java.lang.String nodeSelection) Sets the selection mode.
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".
protected void	setPopupContextRowKey(java.lang.Object rowKey) For internal use only
void	setRowKey(java.lang.Object rowKey) Makes a row current.
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	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.
void	setValue(java.lang.Object value) Specified the model for the component.
void	setVarStatus(java.lang.String varStatus) For internal use only
protected boolean	visitData(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)

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

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, createCollectionModel, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainer, isContainerEmpty, visitHierarchy, visitLevel

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

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

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

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

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

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

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

areRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, isRowAvailable, setRowIndex

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

FOCUS_ROW_KEY_KEY

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

POPUP_CONTEXT_ROW_KEY_KEY

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

DISCLOSED_ROW_KEYS_KEY

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

SELECTION_LISTENER_KEY

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

DISPLAY_LEVELS_CHILDREN_KEY

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

getPopupContextRowKey

protected final java.lang.Object getPopupContextRowKey()

For internal use only

setPopupContextRowKey

protected final void setPopupContextRowKey(java.lang.Object rowKey)

For internal use only

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

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 final java.lang.Object getFocusRowKey()

Gets the rowKey of the currently focused row. The rowKeys of the ancestor rows of the focus row are added to the expandedRowKeys RowKeySet by default.

Specified by:

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

Returns:

the new focusRowKey value

setFocusRowKey

public final void setFocusRowKey(java.lang.Object focusRowKey)

Sets the rowKey of the currently focused row. The rowKeys of the ancestor rows of the focus row are added to the expandedRowKeys RowKeySet by default.

Parameters:

focusRowKey - the new focusRowKey value

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)

For internal use only

getClientRowKey

public java.lang.String getClientRowKey()

Overrides:

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

setRowKey

public final void setRowKey(java.lang.Object rowKey)

Makes a row current. This method calls UIXCollection.preRowDataChange() and UIXCollection.postRowDataChange() as appropriate.

Specified by:

setRowKey in interface org.apache.myfaces.trinidad.model.RowKeyIndex

Overrides:

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

Parameters:

rowKey - The rowKey of the row that should be made current. Use null to clear the current row.

See Also:

CollectionModel#setRowKey

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

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

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

saveToSessionChangeManager

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

For internal use only

visitData

protected boolean visitData(javax.faces.component.visit.VisitContext visitContext,
                            javax.faces.component.visit.VisitCallback callback)

Specified by:

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

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