Skip navigation links

oracle.adf.view.rich.component.rich.layout
Class RichPanelDashboard

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.rich.component.rich.layout.RichPanelDashboard

All Implemented Interfaces:

javax.faces.component.StateHolder

public class RichPanelDashboard

extends org.apache.myfaces.trinidad.component.UIXPanel

panelDashboard features:

• Arranges panelBox (or region with showHeader=always) components into a tiled layout of columns and rows. You can specify the number of columns as well as a CSS length value for the height of the rows.
• Stretches the panelBox children to fit within the width of a column and the specified row height.
• If all of the child panelBoxes cannot fit within the dimensions of the panelDashboard (e.g. due to the specified number of columns and row height), then the panelDashboard will provide a scroll bar so that the user can access the panelBox children that might not be initially viewable.
• Supports being stretched so that you can place the panelDashboard inside of a panelSplitter.
• Provides a dropListener attribute so that you can modify your component tree in response to a reorder gesture performed by the user because of componentDragSource tags inside of the panelBox children.
• Provides methods on the RichPanelDashboard component class that you can use to perform an optimized render of the panelDashboard when you make "insert" or "detete" changes to its children (e.g. changing the rendered flag on a specific child) without requiring that the entire dashboard be redrawn:
  • prepareOptimizedEncodingOfInsertedChild()
  • prepareOptimizedEncodingOfDeletedChild()
• Also, to help make your application feel more responsive to the user, an optional panelDashboardBehavior tag can be used on command components that perform optimized inserts into the dashboard. This tag will cause the dashboard to open up a new location for the child that you are about to insert. The benefit is that this opening up of space happens before your action event is sent to the server so the user will see immediate feedback while your action listener is busy modifying the component tree and preparing the dashboard for the optimized encoding of the insert. If you decide not to use this tag, there will be a slight delay while your action listener is processing before the use sees any change to the dashboard structure.
• The af:panelDashboard tag accepts af:dataFlavor tags as children. You will want to use a data flavor if you want your dashboard's dropListener to handle component drag sources from elsewhere on the page (e.g. from a side bar near the dashboard) instead of only for the direct children of the dashboard. If this side bar represents a menu listing of possible dashboard children that the user can see, you may expose the non-rendered dashboard children as component drag sources in this list. If you do this, a user can then drag from the side bar and drop it into the dashboard at a precise desired drop location among the rendered dashboard children. Your dropListener that you have assigned to the dashboard component can then listen for this gesture, set the requested dashboard child to now be rendered, set its location to be the requested drop position, and perform an optimized render so that only the content for that child is sent to the browser which in turn, gets revealed to the user.

<section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children. e.g. panelStretchLayout or panelSplitter if the dimensionsFrom attribute of this panelDashboard is set to "parent".</html:li> <html:li>This component organizes its children components into a grid based on the number of columns and the rowHeight. The child components that can be stretched inside of the panelDashboard include: <html:ul> <html:li><af:panelBox></html:li> <html:li><af:region></html:li> </html:ul> If you try to put any other component inside of this component (except for af:dataFlavor which can be used to allow discriminants of external drops), then the component hierarchy is illegal. </html:li> </html:ul> There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor: <html:ul> <html:li>You can specify dimensionsFrom="children" for the panelDashboard to be as tall as the number of visible rows multiplied by the rowHeight setting. When using this "children" setting, the topHeight attribute will still be honored (unless percent units are specified) but any height assignment (e.g. inlineStyle or styleClass) on the panelDashboard must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>You can also specify dimensionsFrom="parent" to make the panelDashboard get its dimensions from the inlineStyle and if not provided from there then from its parent component or if not provided from the parent then from the skin.</html:li> <html:li>Using dimensionsFrom="auto" will choose either "children" or "parent" depending on whether the panelDashboard is being stretched by its parent.</html:li> </html:ul> </section>

Events:

Type	Phases	Description
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.

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 org.apache.myfaces.trinidad.bean.PropertyKey	COLUMNS_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 java.lang.String	DIMENSIONS_FROM_AUTO
static java.lang.String	DIMENSIONS_FROM_CHILDREN
static org.apache.myfaces.trinidad.bean.PropertyKey	DIMENSIONS_FROM_KEY
static java.lang.String	DIMENSIONS_FROM_PARENT
static org.apache.myfaces.trinidad.bean.PropertyKey	DROP_LISTENER_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	ROW_HEIGHT_KEY
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.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

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

Method Summary

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.
int	getColumns() Gets the number of columns the width of the dashboard will be divided into
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	getDimensionsFrom() Gets
javax.el.MethodExpression	getDropListener() Gets A method reference to a callback with the signature oracle.adf.view.rich.dnd.DnDAction method(oracle.adf.view.rich.event.DropEvent dropEvent) called when a drop occurs on the component.
java.lang.String	getFamily()
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	getRowHeight() Gets the height of the rows of the grid layout as a CSS length.
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	isVisible() Gets the visibility of the component.
void	prepareOptimizedEncodingOfDeletedChild(javax.faces.context.FacesContext context, int deletedChildIndex) To be used by an action listener that is modifying the children of this panelDashboard.
void	prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context) To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert".
void	prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context, int insertedChildIndex) To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert".
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	setColumns(int columns) Sets the number of columns the width of the dashboard will be divided into
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	setDimensionsFrom(java.lang.String dimensionsFrom) Sets
void	setDropListener(javax.el.MethodExpression dropListener) Sets A method reference to a callback with the signature oracle.adf.view.rich.dnd.DnDAction method(oracle.adf.view.rich.event.DropEvent dropEvent) called when a drop occurs on the 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	setRowHeight(java.lang.String rowHeight) Sets the height of the rows of the grid layout as a CSS length.
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.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

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

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

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

Field Detail

DIMENSIONS_FROM_AUTO

public static final java.lang.String DIMENSIONS_FROM_AUTO

See Also:

Constant Field Values

DIMENSIONS_FROM_CHILDREN

public static final java.lang.String DIMENSIONS_FROM_CHILDREN

See Also:

Constant Field Values

DIMENSIONS_FROM_PARENT

public static final java.lang.String DIMENSIONS_FROM_PARENT

See Also:

Constant Field Values

TYPE

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

DIMENSIONS_FROM_KEY

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

COLUMNS_KEY

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

ROW_HEIGHT_KEY

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

DROP_LISTENER_KEY

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

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

RichPanelDashboard

public RichPanelDashboard()

Construct an instance of the RichPanelDashboard.

RichPanelDashboard

protected RichPanelDashboard(java.lang.String rendererType)

Construct an instance of the RichPanelDashboard.

Method Detail

prepareOptimizedEncodingOfInsertedChild

public void prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context)

To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert". The behavior tag will create the DOM and display a "loading" message. In your action listener, you will adjust the component tree for your children of the panelDashboard. Once that is done, you would then call this method to cause the panelDashboard to draw only its last child. This will skip encoding of all of the other children and swap out the temporary "loading" box with this new last child.

Parameters:

context - the FacesContext

prepareOptimizedEncodingOfInsertedChild

public void prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context,
                                                    int insertedChildIndex)

To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert". The behavior tag will create the DOM and display a "loading" message. In your action listener, you will adjust the component tree for your children of the panelDashboard. Once that is done, you would then call this method to cause the panelDashboard to draw only the specified child. This will skip encoding of all of the other children and swap out the temporary "loading" box with this new child.

Parameters:

context - the FacesContext

insertedChildIndex - the index of the child that has been inserted

prepareOptimizedEncodingOfDeletedChild

public void prepareOptimizedEncodingOfDeletedChild(javax.faces.context.FacesContext context,
                                                   int deletedChildIndex)

To be used by an action listener that is modifying the children of this panelDashboard. Once you have done the work to delete the child, call this method so that the panelDashboard can draw the deletion of this child.

Parameters:

context - the FacesContext

deletedChildIndex - the index of the child that has been deleted

getDimensionsFrom

public final java.lang.String getDimensionsFrom()

Gets

determines how the component will handle geometry management. This specifies where the dimensions of the panelDashboard come from:

<html:ul> <html:li>auto - either "children" or "parent", depending on the container the panelDashboard is inside; if the panelDashboard is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the panelDashboard will get its dimensions from the children (rowHeight will still be honored so the contents of the rows will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the panelDashboard must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>parent (the default) - the panelDashboard will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin</html:li> </html:ul>

Returns:

the new dimensionsFrom value

setDimensionsFrom

public final void setDimensionsFrom(java.lang.String dimensionsFrom)

Sets

determines how the component will handle geometry management. This specifies where the dimensions of the panelDashboard come from:

<html:ul> <html:li>auto - either "children" or "parent", depending on the container the panelDashboard is inside; if the panelDashboard is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the panelDashboard will get its dimensions from the children (rowHeight will still be honored so the contents of the rows will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the panelDashboard must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>parent (the default) - the panelDashboard will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin</html:li> </html:ul>

Parameters:

dimensionsFrom - the new dimensionsFrom value

getColumns

public final int getColumns()

Gets the number of columns the width of the dashboard will be divided into

Returns:

the new columns value

setColumns

public final void setColumns(int columns)

Sets the number of columns the width of the dashboard will be divided into

Parameters:

columns - the new columns value

getRowHeight

public final java.lang.String getRowHeight()

Gets the height of the rows of the grid layout as a CSS length. If dimensionsFrom resolves to "children", percent units are not allowed and the default value is used instead.

Returns:

the new rowHeight value

setRowHeight

public final void setRowHeight(java.lang.String rowHeight)

Sets the height of the rows of the grid layout as a CSS length. If dimensionsFrom resolves to "children", percent units are not allowed and the default value is used instead.

Parameters:

rowHeight - the new rowHeight value

getDropListener

public final javax.el.MethodExpression getDropListener()

Gets A method reference to a callback with the signature oracle.adf.view.rich.dnd.DnDAction method(oracle.adf.view.rich.event.DropEvent dropEvent) called when a drop occurs on the component. Since the panelDashboard will automatically adjust the positions of its children in the browser, this method should return DnDAction.NONE if your handler is successful in adjusting the position of the reordered children since this will cause the panelDashboard to be left as is. If you return DnDAction.MOVE, the panelDashboard will be redrawn. You may wish to use org.apache.myfaces.trinidad.change.ReorderChildrenComponentChange if you wish to preserve a new ordering of the children. The dropEvent.getDropSiteIndex() method will give you the location that the user desires the dragged component to end up at. Use dropEvent.getTransferable().getData(DataFlavor.UICOMPONENT_FLAVOR) to get the dragged component.

Returns:

the new dropListener value

setDropListener

public final void setDropListener(javax.el.MethodExpression dropListener)

Sets A method reference to a callback with the signature oracle.adf.view.rich.dnd.DnDAction method(oracle.adf.view.rich.event.DropEvent dropEvent) called when a drop occurs on the component. Since the panelDashboard will automatically adjust the positions of its children in the browser, this method should return DnDAction.NONE if your handler is successful in adjusting the position of the reordered children since this will cause the panelDashboard to be left as is. If you return DnDAction.MOVE, the panelDashboard will be redrawn. You may wish to use org.apache.myfaces.trinidad.change.ReorderChildrenComponentChange if you wish to preserve a new ordering of the children. The dropEvent.getDropSiteIndex() method will give you the location that the user desires the dragged component to end up at. Use dropEvent.getTransferable().getData(DataFlavor.UICOMPONENT_FLAVOR) to get the dragged component.

Parameters:

dropListener - the new dropListener 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.UIXPanel

getBeanType

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

Overrides:

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

Skip navigation links