Skip navigation links

oracle.adf.view.rich.component.rich.output
Class RichPanelCollection

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXDecorateCollection
oracle.adf.view.rich.component.rich.output.RichPanelCollection

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichPanelCollection

extends org.apache.myfaces.trinidad.component.UIXDecorateCollection

implements javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer

A panel component that aggregates collection components like table, treeTable and tree to display standard/application menus, toolbars and statusbar items.

The default top level menu and toolbar items vary depending on the component used as the child of the panelCollection.

• For table, tree and treeTable, the default top level menu item is View.
• For table and treeTable with selectable columns, the default top level menu items are View and Format.
• For table and treeTable, the default toolbar item is Detach.
• For table and treeTable with selectable columns, the default top level toolbar items are Freeze, Detach and Wrap.
• For tree and treeTable, if the pathStamp facet is used, the toolbar buttons Go Up, Go To Top, Show as Top also appear.

Table, treeTable and tree must be a direct child of this component. For example, a switcher holding tables, treeTables or trees is not accepted as a valid child component.

Context menus and other popups can be displayed for the encapsulated table, treeTable and tree by placing an "af:popup" component inside this component.

Please note that panelCollection is a naming container so if you want to add its contained components as partialTriggers (for e.g. table), you need to make them a fully qualified name. For e.g. if you have a panelCollection with id="entriesCollection" and a table inside it with id="deptTable" and if you want to update a panelForm on the selection change of the table, you need to declare it as follows:
<panelForm partialTriggers="entriesCollection:deptTable">

<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.</html:li> <html:li>This component will stretch the single <af:table>, <af:tree>, or <af:treeTable> child that it is wrapping so that the child fits snugly inside.</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 event might include the width of a column that supported client-side resizing.

Field Summary

static String	AFTER_TOOLBAR_FACET
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 String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static String	DEFAULT_TOOLBAR_ITEM_DISPLAY_ICON
static String	DEFAULT_TOOLBAR_ITEM_DISPLAY_ICON_AND_TEXT
static org.apache.myfaces.trinidad.bean.PropertyKey	DEFAULT_TOOLBAR_ITEM_DISPLAY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FEATURES_OFF_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static String	MENUS_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static String	SECONDARY_TOOLBAR_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static String	STATUSBAR_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static String	TOOLBAR_FACET
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static String	VIEW_MENU_FACET
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

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

	RichPanelCollection() Construct an instance of the RichPanelCollection.
protected	RichPanelCollection(String rendererType) Construct an instance of the RichPanelCollection.

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
javax.faces.component.UIComponent	getAfterToolbar() Insert what you would like to appear inside the second toolbox row of the panelCollection.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
Set	getClientAttributes() Gets a set of client attribute names.
Map<String,List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
ClientListenerSet	getClientListeners() Gets a set of client listeners.
String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
String	getDefaultEventName()
String	getDefaultToolbarItemDisplay() Gets Attribute used to hide the text for the default toolbar items.
Collection<String>	getEventNames()
String	getFamily()
Set	getFeaturesOff() Gets a space-separated list of default features to turn off for the panelCollection.
String	getInlineStyle() Gets the CSS styles to use for this component.
javax.faces.component.UIComponent	getMenus() Insert a menu (an "af:menu" component) into this facet to include your own custom menu.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
javax.faces.component.UIComponent	getSecondaryToolbar() Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to contain additional toolbar items.
String	getShortDesc() Gets the short description of the component.
javax.faces.component.UIComponent	getStatusbar() Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to include extra statusbar items.
String	getStyleClass() Gets a CSS style class to use for this component.
javax.faces.component.UIComponent	getToolbar() Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to contain additional toolbar items.
Set<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.
javax.faces.component.UIComponent	getViewMenu() Used to add items to the panelCollection's "View" menu.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isVisible() Gets the visibility of the component.
void	setAfterToolbar(javax.faces.component.UIComponent afterToolbarFacet) Insert what you would like to appear inside the second toolbox row of the panelCollection.
void	setClientAttributes(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(String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDefaultToolbarItemDisplay(String defaultToolbarItemDisplay) Sets Attribute used to hide the text for the default toolbar items.
void	setFeaturesOff(Set featuresOff) Sets a space-separated list of default features to turn off for the panelCollection.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setMenus(javax.faces.component.UIComponent menusFacet) Insert a menu (an "af:menu" component) into this facet to include your own custom menu.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setSecondaryToolbar(javax.faces.component.UIComponent secondaryToolbarFacet) Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to contain additional toolbar items.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setStatusbar(javax.faces.component.UIComponent statusbarFacet) Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to include extra statusbar items.
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
void	setToolbar(javax.faces.component.UIComponent toolbarFacet) Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to contain additional toolbar items.
void	setUnsecure(Set<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	setViewMenu(javax.faces.component.UIComponent viewMenuFacet) Used to add items to the panelCollection's "View" menu.
void	setVisible(boolean visible) Sets the visibility of the component.

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

getContainerClientId, getCurrencyString, invokeOnComponent, setCurrencyString

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

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

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

addPartialTarget, 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, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TOOLBAR_ITEM_DISPLAY_ICON_AND_TEXT

public static final String DEFAULT_TOOLBAR_ITEM_DISPLAY_ICON_AND_TEXT

See Also:

Constant Field Values

DEFAULT_TOOLBAR_ITEM_DISPLAY_ICON

public static final String DEFAULT_TOOLBAR_ITEM_DISPLAY_ICON

See Also:

Constant Field Values

TYPE

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

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

FEATURES_OFF_KEY

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

DEFAULT_TOOLBAR_ITEM_DISPLAY_KEY

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

MENUS_FACET

public static final String MENUS_FACET

See Also:

Constant Field Values

VIEW_MENU_FACET

public static final String VIEW_MENU_FACET

See Also:

Constant Field Values

TOOLBAR_FACET

public static final String TOOLBAR_FACET

See Also:

Constant Field Values

SECONDARY_TOOLBAR_FACET

public static final String SECONDARY_TOOLBAR_FACET

See Also:

Constant Field Values

AFTER_TOOLBAR_FACET

public static final String AFTER_TOOLBAR_FACET

See Also:

Constant Field Values

STATUSBAR_FACET

public static final String STATUSBAR_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichPanelCollection

public RichPanelCollection()

Construct an instance of the RichPanelCollection.

RichPanelCollection

protected RichPanelCollection(String rendererType)

Construct an instance of the RichPanelCollection.

Method Detail

getMenus

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

Insert a menu (an "af:menu" component) into this facet to include your own custom menu. This menu will be the first menu shown on the panelCollection menuBar, and is followed by the "View" and "Format" menus that are provided by the panelCollection compoent. You can not add more than one top level menu item. This menu item can have as many nested children as you want. The menubar is the first child compoent of the toolbox. The toolbox manages two types of elements menubars and toolbars. In the panel collection we create one menu bar and one toolbar. There are three more facets that allow developers to add toolbars or menuBars of their choosing. These are called the "toolbar", "secondaryToolbar" and "afterToolbar" facets. You must select either an "af:toolbar" or an "af:menuBar" for the "toolbar" and "secondaryToolbar" facets. The "afterToolbar" is displayed in a separate row inside the toolbox. This facet can contain anything that would normally go in a toolbox row, namely an "af:toolbar", an "af:menuBar" or an "af:group" containing toolbar components.

setMenus

public final void setMenus(javax.faces.component.UIComponent menusFacet)

Insert a menu (an "af:menu" component) into this facet to include your own custom menu. This menu will be the first menu shown on the panelCollection menuBar, and is followed by the "View" and "Format" menus that are provided by the panelCollection compoent. You can not add more than one top level menu item. This menu item can have as many nested children as you want. The menubar is the first child compoent of the toolbox. The toolbox manages two types of elements menubars and toolbars. In the panel collection we create one menu bar and one toolbar. There are three more facets that allow developers to add toolbars or menuBars of their choosing. These are called the "toolbar", "secondaryToolbar" and "afterToolbar" facets. You must select either an "af:toolbar" or an "af:menuBar" for the "toolbar" and "secondaryToolbar" facets. The "afterToolbar" is displayed in a separate row inside the toolbox. This facet can contain anything that would normally go in a toolbox row, namely an "af:toolbar", an "af:menuBar" or an "af:group" containing toolbar components.

getViewMenu

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

Used to add items to the panelCollection's "View" menu. A single menu item (meaning an "af:menu", "af:commandMenuItem", or "af:goMenuItem") can be added to this facet. Alternately, you can add a group (an "af:group" component) into this facet to include multiple grouped menu items in the "View" menu.

setViewMenu

public final void setViewMenu(javax.faces.component.UIComponent viewMenuFacet)

Used to add items to the panelCollection's "View" menu. A single menu item (meaning an "af:menu", "af:commandMenuItem", or "af:goMenuItem") can be added to this facet. Alternately, you can add a group (an "af:group" component) into this facet to include multiple grouped menu items in the "View" menu.

getToolbar

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

Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to contain additional toolbar items. This toolbar is displayed after the standard menubar and before the standard toolbar inserted by the panelCollection.

setToolbar

public final void setToolbar(javax.faces.component.UIComponent toolbarFacet)

Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to contain additional toolbar items. This toolbar is displayed after the standard menubar and before the standard toolbar inserted by the panelCollection.

getSecondaryToolbar

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

Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to contain additional toolbar items. This toolbar is displayed after the standard toolbar provided by the panelCollection. The secondaryToolbar is is the right most toolbar in the toolbox row.

setSecondaryToolbar

public final void setSecondaryToolbar(javax.faces.component.UIComponent secondaryToolbarFacet)

Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to contain additional toolbar items. This toolbar is displayed after the standard toolbar provided by the panelCollection. The secondaryToolbar is is the right most toolbar in the toolbox row.

getAfterToolbar

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

Insert what you would like to appear inside the second toolbox row of the panelCollection. Valid entries match what is allowed in a toolbox row, which is an "af:toolbar", an "af:menuBar", or an "af:group" containing toolbar components. The afterToolbar contents appear in a separate row below the toolbox row containing the normal group of toolbars.

setAfterToolbar

public final void setAfterToolbar(javax.faces.component.UIComponent afterToolbarFacet)

Insert what you would like to appear inside the second toolbox row of the panelCollection. Valid entries match what is allowed in a toolbox row, which is an "af:toolbar", an "af:menuBar", or an "af:group" containing toolbar components. The afterToolbar contents appear in a separate row below the toolbox row containing the normal group of toolbars.

getStatusbar

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

Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to include extra statusbar items. These statusbar items are merged with the standard items shown in the status bar at the bottom of the panelCollection.

setStatusbar

public final void setStatusbar(javax.faces.component.UIComponent statusbarFacet)

Insert a toolbar (either an "af:toolbar" or "af:menuBar") element in this facet to include extra statusbar items. These statusbar items are merged with the standard items shown in the status bar at the bottom of the panelCollection.

getInlineStyle

public final 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. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. 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(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. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. 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 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(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 String getShortDesc()

Gets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)

Sets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final Set<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. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(Set<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. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

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 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(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 Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final 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(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

getFeaturesOff

public final Set getFeaturesOff()

Gets a space-separated list of default features to turn off for the panelCollection. Supported values are:

Value	Turns off
statusBar	Status bar
viewMenu	'View' menu
formatMenu	'Format' menu
columnsMenuItem	'Columns' sub-menu item
columnsMenuItem:col1,col20	Columns with column ID: 'col1' and 'col20' inside 'Columns' sub-menu
freezeMenuItem	'Freeze' menu item
detachMenuItem	'Detach' menu item
sortMenuItem	'Sort' menu item
reorderColumnsMenuItem	'Reorder Columns' menu item
resizeColumnsMenuItem	'Resize Columns' menu item
wrapMenuItem	'Wrap' menu item
showAsTopMenuItem	Tree/TreeTable 'Show As Top' menu item
scrollToFirstMenuItem	Tree/TreeTable 'Scroll To First' menu item
scrollToLastMenuItem	Tree/TreeTable 'Scroll To Last' menu item
freezeToolbarItem	'Freeze' toolbar item
detachToolbarItem	'Detach' toolbar item
wrapToolbarItem	'Wrap' toolbar item
showAsTopToolbarItem	Tree/TreeTable 'Show As Top' toolbar item
wrap	'Wrap' menu and toolbar items
freeze	'Freeze' menu and toolbar items
detach	'Detach' menu and toolbar items

Returns:

the new featuresOff value

setFeaturesOff

public final void setFeaturesOff(Set featuresOff)

Sets a space-separated list of default features to turn off for the panelCollection. Supported values are:

Value	Turns off
statusBar	Status bar
viewMenu	'View' menu
formatMenu	'Format' menu
columnsMenuItem	'Columns' sub-menu item
columnsMenuItem:col1,col20	Columns with column ID: 'col1' and 'col20' inside 'Columns' sub-menu
freezeMenuItem	'Freeze' menu item
detachMenuItem	'Detach' menu item
sortMenuItem	'Sort' menu item
reorderColumnsMenuItem	'Reorder Columns' menu item
resizeColumnsMenuItem	'Resize Columns' menu item
wrapMenuItem	'Wrap' menu item
showAsTopMenuItem	Tree/TreeTable 'Show As Top' menu item
scrollToFirstMenuItem	Tree/TreeTable 'Scroll To First' menu item
scrollToLastMenuItem	Tree/TreeTable 'Scroll To Last' menu item
freezeToolbarItem	'Freeze' toolbar item
detachToolbarItem	'Detach' toolbar item
wrapToolbarItem	'Wrap' toolbar item
showAsTopToolbarItem	Tree/TreeTable 'Show As Top' toolbar item
wrap	'Wrap' menu and toolbar items
freeze	'Freeze' menu and toolbar items
detach	'Detach' menu and toolbar items

Parameters:

featuresOff - the new featuresOff value

getDefaultToolbarItemDisplay

public final String getDefaultToolbarItemDisplay()

Gets Attribute used to hide the text for the default toolbar items. Use "icon" to hide the text or "iconAndText" to display the text with the icon

Returns:

the new defaultToolbarItemDisplay value

setDefaultToolbarItemDisplay

public final void setDefaultToolbarItemDisplay(String defaultToolbarItemDisplay)

Sets Attribute used to hide the text for the default toolbar items. Use "icon" to hide the text or "iconAndText" to display the text with the icon

Parameters:

defaultToolbarItemDisplay - the new defaultToolbarItemDisplay value

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()

Specified by:

getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public String getFamily()

Overrides:

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

getBeanType

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

Overrides:

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

Skip navigation links