Skip navigation links

oracle.adf.view.rich.component.rich.data
Class RichListView

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.UIXIterator
org.apache.myfaces.trinidad.component.UIXListView
oracle.adf.view.rich.component.rich.data.RichListView

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, DragSourceFactory, org.apache.myfaces.trinidad.component.CollectionComponent, org.apache.myfaces.trinidad.component.FlattenedComponent, org.apache.myfaces.trinidad.model.LocalRowKeyIndex, org.apache.myfaces.trinidad.model.RowKeyIndex

public class RichListView

extends org.apache.myfaces.trinidad.component.UIXListView

implements org.apache.myfaces.trinidad.component.CollectionComponent, org.apache.myfaces.trinidad.model.RowKeyIndex, DragSourceFactory

The component displays a List of Items based on rows of a collection model. <section name="ListView_Model"> The ListView component uses a model to access the data in the underlying list. The specific model class is oracle.adf.view.rich.model.CollectionModel. You may also use other model instances, e.g., java.util.List, array, and javax.faces.model.DataModel. The listView will automatically convert the instance into a CollectionModel. Please note that if the TreeModel implementation is provided, the ListView shall display group header area for each row(with or without disclosure). Initial implementation will only support only one level of disclosure. If the treeModel contains more than one level of data, we will specifically throw an error to prevent any ambiguity. </section> <section name="Fetch_Size"> The ListView component shall not display on the client all the rows that are available on the server. "fetchSize" is the number of rows requested from the client to the server on each attempt to fill the component.</section> <section name="Geometry_Management"> <html:ul> <html:li>By default the ListView component does not have any dimensions. So it will flow to the dimensions of its content.</html:li> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout, panelSplitter. In such a scenario, it will show scrollbars so that the content can be scrolled.</html:li> <html:li>This component only accepts listItem children and they will be layed out as stamps vertically. </html:li> </html:ul> </section> <section name="Attribute_Notes"> The "first" and "rows" attributes inherited from the UIXIterator superclass are not currently supported for the rich render kit. </section>

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.SelectionEvent	Apply Request Values Invoke Application	The selection event is delivered when the table selection changes.
org.apache.myfaces.trinidad.event.RowDisclosureEvent	Apply Request Values Invoke Application	The expansion event is generated for a table when the detail facet of a row is expanded or collapsed. For tree or a treeTable, the expansion event is generated when tree nodes are expanded or collapsed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

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	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_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	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	EMPTY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FETCH_SIZE_KEY
static java.lang.String	GROUP_DISCLOSURE_POLICY_INITIALLY_EXPANDED
static org.apache.myfaces.trinidad.bean.PropertyKey	GROUP_DISCLOSURE_POLICY_KEY
static java.lang.String	GROUP_DISCLOSURE_POLICY_NO_DISCLOSURE
static java.lang.String	GROUP_HEADER_STAMP_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	IMMEDIATE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTION_KEY
static java.lang.String	SELECTION_MULTIPLE
static java.lang.String	SELECTION_NONE
static java.lang.String	SELECTION_SINGLE
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

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

GROUP_DISCLOSED_ROW_KEYS_KEY, GROUP_DISCLOSURE_LISTENER_KEY, SELECTED_ROW_KEYS_KEY, SELECTION_LISTENER_KEY

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

FIRST_KEY, ROWS_KEY, VALUE_KEY, 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

	RichListView() Construct an instance of the RichListView.
protected	RichListView(java.lang.String rendererType) Construct an instance of the RichListView.

Method Summary

DragSource	createDragSource(java.lang.String name, java.util.Set<DnDAction> allowedActions, DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties) Returns the server DragSource, or null if no DragSource should be attached.
java.lang.CharSequence	createDragSourceBehavior(java.lang.String name, DragSource dragSource, java.util.Set<DnDAction> allowedActions, DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties) Returns the client DragSource initializer.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.util.Set	getClientAttributes() Gets a set of client attribute names.
ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
java.lang.String	getEmptyText() Gets the text of an empty ListView.
java.lang.String	getFamily()
int	getFetchSize() Gets the number of items in the data fetch block
java.lang.String	getGroupDisclosurePolicy() Gets specifies the policy for disclosing groups.
javax.faces.component.UIComponent	getGroupHeaderStamp() the component used to stamp children to display in the group header(with or without disclosure) region of the ListView.
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getSelection() Gets whether listItem in this listView are selectable.
java.lang.String	getShortDesc() Gets the short description of the component.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.util.Set<java.lang.String>	getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isImmediate() Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
boolean	isVisible() Gets the visibility of the component.
void	setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setEmptyText(java.lang.String emptyText) Sets the text of an empty ListView.
void	setFetchSize(int fetchSize) Sets the number of items in the data fetch block
void	setGroupDisclosurePolicy(java.lang.String groupDisclosurePolicy) Sets specifies the policy for disclosing groups.
void	setGroupHeaderStamp(javax.faces.component.UIComponent groupHeaderStampFacet) the component used to stamp children to display in the group header(with or without disclosure) region of the ListView.
void	setImmediate(boolean immediate) Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setSelection(java.lang.String selection) Sets whether listItem in this listView are selectable.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the component.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setUnsecure(java.util.Set<java.lang.String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
void	setVisible(boolean visible) Sets the visibility of the component.

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

addRowDisclosureListener, addSelectionListener, broadcast, createFacesBean, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getGroupDisclosedRowKeys, getGroupDisclosureListener, getRowDisclosureListeners, getSelectedRowKeys, getSelectionListener, getSelectionListeners, isContainer, isContainerEmpty, postCreateCollectionModel, queueEvent, removeRowDisclosureListener, removeSelectionListener, setGroupDisclosedRowKeys, setGroupDisclosureListener, setSelectedRowKeys, setSelectionListener

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

createCollectionModel, createVarStatusMap, encodeChildren, getFirst, getRendersChildren, getRows, getValue, getVarStatus, isFlatteningChildren, processFacetsAndChildren, processFlattenedChildren, setFirst, setRows, setValue, setVarStatus, visitTree

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, getStamps, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, 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, decode, decodeChildren, 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, getRendererType, 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, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, 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

getFirst, getRows, 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

SELECTION_NONE

public static final java.lang.String SELECTION_NONE

See Also:

Constant Field Values

SELECTION_SINGLE

public static final java.lang.String SELECTION_SINGLE

See Also:

Constant Field Values

SELECTION_MULTIPLE

public static final java.lang.String SELECTION_MULTIPLE

See Also:

Constant Field Values

GROUP_DISCLOSURE_POLICY_NO_DISCLOSURE

public static final java.lang.String GROUP_DISCLOSURE_POLICY_NO_DISCLOSURE

See Also:

Constant Field Values

GROUP_DISCLOSURE_POLICY_INITIALLY_EXPANDED

public static final java.lang.String GROUP_DISCLOSURE_POLICY_INITIALLY_EXPANDED

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

FETCH_SIZE_KEY

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

SELECTION_KEY

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

EMPTY_TEXT_KEY

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

IMMEDIATE_KEY

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

GROUP_DISCLOSURE_POLICY_KEY

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

SHORT_DESC_KEY

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

UNSECURE_KEY

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

VISIBLE_KEY

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

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

CLIENT_COMPONENT_KEY

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

CLIENT_ATTRIBUTES_KEY

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

PARTIAL_TRIGGERS_KEY

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

CLIENT_LISTENERS_KEY

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

GROUP_HEADER_STAMP_FACET

public static final java.lang.String GROUP_HEADER_STAMP_FACET

See Also:

Constant Field Values

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

RichListView

public RichListView()

Construct an instance of the RichListView.

RichListView

protected RichListView(java.lang.String rendererType)

Construct an instance of the RichListView.

Method Detail

createDragSource

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

Description copied from interface: DragSourceFactory

Returns the server DragSource, or null if no DragSource should be attached.

Specified by:

createDragSource in interface DragSourceFactory

Parameters:

name - refers to a named DragSource; "default" refers to the default DragSource

allowedActions - Set of DnDAction supported by the DragSource.

defaultAction - Default drag and drop action supported by this drag source

discriminant - The discriminant for the default DataFlavors generated by this drag source.

dragDropEndListener - A method reference to an event of the signature void method(DropEvent) that is invoked after the drag drop operation ends.

properties - allows for additional properties in the future

Returns:

DragSource

createDragSourceBehavior

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

Description copied from interface: DragSourceFactory

Returns the client DragSource initializer.

Specified by:

createDragSourceBehavior in interface DragSourceFactory

Parameters:

name - refers to a named DragSource; "default" refers to the default DragSource

dragSource - DragSource to create clientDragSource initializer for.

allowedActions - Set of DnDAction supported by the DragSource.

defaultAction - Default drag and drop action supported by this drag source

discriminant - The discriminant for the default DataFlavors generated by this drag source.

dragDropEndListener - A method reference to an event of the signature void method(DropEvent) that is invoked after the drag drop operation ends.

properties - allows for additional properties in the future

Returns:

CharSequence

getGroupHeaderStamp

public final javax.faces.component.UIComponent getGroupHeaderStamp()

the component used to stamp children to display in the group header(with or without disclosure) region of the ListView. A listItem child is required. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

setGroupHeaderStamp

public final void setGroupHeaderStamp(javax.faces.component.UIComponent groupHeaderStampFacet)

the component used to stamp children to display in the group header(with or without disclosure) region of the ListView. A listItem child is required. As with JSP pages, when using Facelets, multiple components are not allowed in this facet.

getFetchSize

public final int getFetchSize()

Gets the number of items in the data fetch block

Returns:

the new fetchSize value

setFetchSize

public final void setFetchSize(int fetchSize)

Sets the number of items in the data fetch block

Parameters:

fetchSize - the new fetchSize value

getSelection

public final java.lang.String getSelection()

Gets whether listItem in this listView are selectable. Use the value "single" to enable single selection, "multiple" to enable multiple selection. The default is "none", which means no items are selected

Returns:

the new selection value

setSelection

public final void setSelection(java.lang.String selection)

Sets whether listItem in this listView are selectable. Use the value "single" to enable single selection, "multiple" to enable multiple selection. The default is "none", which means no items are selected

Parameters:

selection - the new selection value

getEmptyText

public final java.lang.String getEmptyText()

Gets the text of an empty ListView. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.

Returns:

the new emptyText value

setEmptyText

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

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

Parameters:

emptyText - the new emptyText value

isImmediate

public final boolean isImmediate()

Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.

Returns:

the new immediate value

setImmediate

public final void setImmediate(boolean immediate)

Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.

Parameters:

immediate - the new immediate value

getGroupDisclosurePolicy

public final java.lang.String getGroupDisclosurePolicy()

Gets specifies the policy for disclosing groups. possible values are: null(default), noDisclosure, initiallyExpanded. If groupDisclosurePolicy="noDisclosure" is set and the model is a treeModel, all group headers will be displayed and there will be no way to collapse the groups. Attribute value "initiallyExpanded" can be used to expand all groups initially.

Returns:

the new groupDisclosurePolicy value

setGroupDisclosurePolicy

public final void setGroupDisclosurePolicy(java.lang.String groupDisclosurePolicy)

Sets specifies the policy for disclosing groups. possible values are: null(default), noDisclosure, initiallyExpanded. If groupDisclosurePolicy="noDisclosure" is set and the model is a treeModel, all group headers will be displayed and there will be no way to collapse the groups. Attribute value "initiallyExpanded" can be used to expand all groups initially.

Parameters:

groupDisclosurePolicy - the new groupDisclosurePolicy value

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

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. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Returns:

the new shortDesc value

setShortDesc

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

Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()

Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)

Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

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

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

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

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXListView

getBeanType

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

Overrides:

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

Skip navigation links