|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.3.0) E17488-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class RichPanelCollection
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.
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>
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 java.lang.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 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 |
DEFAULT_TOOLBAR_ITEM_DISPLAY_ICON |
static java.lang.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 java.lang.String |
MENUS_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static java.lang.String |
SECONDARY_TOOLBAR_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static java.lang.String |
STATUSBAR_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static java.lang.String |
TOOLBAR_FACET |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static java.lang.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 |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
|
RichPanelCollection() Construct an instance of the RichPanelCollection. |
protected |
RichPanelCollection(java.lang.String rendererType) Construct an instance of the RichPanelCollection. |
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.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() |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
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 |
getDefaultEventName() |
java.lang.String |
getDefaultToolbarItemDisplay() Gets Attribute used to hide the text for the default toolbar items. |
java.util.Collection<java.lang.String> |
getEventNames() |
java.lang.String |
getFamily() |
java.util.Set |
getFeaturesOff() Gets a space-separated list of default features to turn off for the panelCollection. |
java.lang.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. |
java.lang.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. |
java.lang.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. |
java.lang.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. |
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. |
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(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 |
setDefaultToolbarItemDisplay(java.lang.String defaultToolbarItemDisplay) Sets Attribute used to hide the text for the default toolbar items. |
void |
setFeaturesOff(java.util.Set featuresOff) Sets a space-separated list of default features to turn off for the panelCollection. |
void |
setInlineStyle(java.lang.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(java.lang.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(java.lang.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(java.lang.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(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 |
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, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, 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, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, 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, subscribeToEvent, 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, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_TOOLBAR_ITEM_DISPLAY_ICON_AND_TEXT
public static final java.lang.String DEFAULT_TOOLBAR_ITEM_DISPLAY_ICON
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey FEATURES_OFF_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DEFAULT_TOOLBAR_ITEM_DISPLAY_KEY
public static final java.lang.String MENUS_FACET
public static final java.lang.String VIEW_MENU_FACET
public static final java.lang.String TOOLBAR_FACET
public static final java.lang.String SECONDARY_TOOLBAR_FACET
public static final java.lang.String AFTER_TOOLBAR_FACET
public static final java.lang.String STATUSBAR_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichPanelCollection()
protected RichPanelCollection(java.lang.String rendererType)
Method Detail |
---|
public final javax.faces.component.UIComponent getMenus()
public final void setMenus(javax.faces.component.UIComponent menusFacet)
public final javax.faces.component.UIComponent getViewMenu()
public final void setViewMenu(javax.faces.component.UIComponent viewMenuFacet)
public final javax.faces.component.UIComponent getToolbar()
public final void setToolbar(javax.faces.component.UIComponent toolbarFacet)
public final javax.faces.component.UIComponent getSecondaryToolbar()
public final void setSecondaryToolbar(javax.faces.component.UIComponent secondaryToolbarFacet)
public final javax.faces.component.UIComponent getAfterToolbar()
public final void setAfterToolbar(javax.faces.component.UIComponent afterToolbarFacet)
public final javax.faces.component.UIComponent getStatusbar()
public final void setStatusbar(javax.faces.component.UIComponent statusbarFacet)
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final java.util.Set getFeaturesOff()
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 |
public final void setFeaturesOff(java.util.Set featuresOff)
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 |
featuresOff
- the new featuresOff valuepublic final java.lang.String getDefaultToolbarItemDisplay()
public final void setDefaultToolbarItemDisplay(java.lang.String defaultToolbarItemDisplay)
defaultToolbarItemDisplay
- the new defaultToolbarItemDisplay valuepublic java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXDecorateCollection
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXDecorateCollection
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.3.0) E17488-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |