|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
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.UIXShowOne
oracle.adf.view.rich.component.rich.layout.RichPanelTabbed
public class RichPanelTabbed
The panelTabbed control can be used to display a group of contents that belongs to a showDetailItem. Tab bar(s) with tabs representing the showDetailItem children are displayed. Selecting a tab, displays the associated showDetailItem. If none of the showDetailItem children are selected, the first showDetailItem that is enabled is selected. Typically you would put one or more showDetailItem components inside of the panelTabbed but you may also alternatively place a facetRef, group, iterator, or switcher inside of the panelTabbed as long as these wrappers provide showDetailItem components as a result of their execution.
<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 if the dimensionsFrom attribute is set to "parent".</html:li> <html:li>This component uses <af:showDetailItem> to organize content into each tab body panel. The <af:showDetailItem> will allow stretching if: <html:ul> <html:li>The panelTabbed has dimensionsFrom="parent"</html:li> <html:li>It contains a single child</html:li> <html:li>It has stretchChildren="first" specified</html:li> <html:li>The child has no width, height, margin, border, and padding</html:li> <html:li>The child must be capable of being stretched</html:li> </html:ul> Examples of components that can be stretched inside of a <af:showDetailItem> include: <html:ul> <html:li><af:decorativeBox></html:li> <html:li><af:panelAccordion></html:li> <html:li><af:panelBox></html:li> <html:li><af:panelCollection></html:li> <html:li><af:panelGroupLayout layout="scroll"></html:li> <html:li><af:panelGroupLayout layout="vertical"></html:li> <html:li><af:panelHeader></html:li> <html:li><af:panelSplitter></html:li> <html:li><af:panelStretchLayout></html:li> <html:li><af:panelTabbed></html:li> <html:li><af:region></html:li> <html:li><af:table></html:li> <html:li><af:tree></html:li> <html:li><af:treeTable></html:li> </html:ul> If you try to put a component inside of this component and that child component does not support being stretched, then the component hierarchy is illegal. To make it legal, you need to insert another intermediate component between this component and the child component. This intermediate component must support being stretched and must not stretch its children. An example of such a component that is commonly used for this purpose is <af:panelGroupLayout layout="scroll">. By using a wrapper like this, you create a flowing layout area where nothing will be stretched inside of it. Examples of components that do not support being stretched inside of these panelStretchLayout facets (and therefore need to be wrapped) include: <html:ul> <html:li><af:panelBorderLayout></html:li> <html:li><af:panelFormLayout></html:li> <html:li><af:panelGroupLayout layout="default"></html:li> <html:li><af:panelGroupLayout layout="horizontal"></html:li> <html:li><af:panelLabelAndMessage></html:li> <html:li><af:panelList></html:li> <html:li><trh:tableLayout></html:li> </html:ul> </html:li> </html:ul> </section>
Type | Phases | Description |
---|---|---|
oracle.adf.view.rich.event.ItemEvent |
Apply Request Values | The itemEvent is triggered when a containing object has an event on one of its child items. For example, a panelTabbed will launch an itemEvent of type 'remove' for one of its child tabs. |
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 java.lang.String |
CHILD_CREATION_IMMEDIATE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CHILD_CREATION_KEY |
static java.lang.String |
CHILD_CREATION_LAZY |
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 |
DIMENSIONS_FROM_AUTO |
static java.lang.String |
DIMENSIONS_FROM_DISCLOSED_CHILD |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DIMENSIONS_FROM_KEY |
static java.lang.String |
DIMENSIONS_FROM_PARENT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static java.lang.String |
POSITION_ABOVE |
static java.lang.String |
POSITION_BELOW |
static java.lang.String |
POSITION_BOTH |
static org.apache.myfaces.trinidad.bean.PropertyKey |
POSITION_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static java.lang.String |
TAB_REMOVAL_ALL |
static java.lang.String |
TAB_REMOVAL_ALL_EXCEPT_LAST |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TAB_REMOVAL_KEY |
static java.lang.String |
TAB_REMOVAL_NONE |
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 | |
---|---|
|
RichPanelTabbed() Construct an instance of the RichPanelTabbed. |
protected |
RichPanelTabbed(java.lang.String rendererType) Construct an instance of the RichPanelTabbed. |
Method Summary | |
---|---|
void |
addItemListener(ItemListener listener) Adds a item listener. |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.lang.String |
getChildCreation() Gets Controls when the contetns of the ShowDetailItem children are created. |
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 |
getDimensionsFrom() Gets |
java.lang.String |
getFamily() |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
ItemListener[] |
getItemListeners() Returns an array of attached item listeners. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getPosition() Gets the position of the tab bar. |
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.lang.String |
getTabRemoval() Gets determines if tab removal is enabled. |
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 |
removeItemListener(ItemListener listener) Removes a item listener. |
void |
setChildCreation(java.lang.String childCreation) Sets Controls when the contetns of the ShowDetailItem children are created. |
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 |
setDimensionsFrom(java.lang.String dimensionsFrom) Sets |
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 |
setPosition(java.lang.String position) Sets the position of the tab bar. |
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 |
setTabRemoval(java.lang.String tabRemoval) Sets determines if tab removal is enabled. |
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.UIXShowOne |
---|
queueEvent |
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, 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 |
---|
public static final java.lang.String CHILD_CREATION_IMMEDIATE
public static final java.lang.String CHILD_CREATION_LAZY
public static final java.lang.String DIMENSIONS_FROM_AUTO
public static final java.lang.String DIMENSIONS_FROM_DISCLOSED_CHILD
public static final java.lang.String DIMENSIONS_FROM_PARENT
public static final java.lang.String POSITION_ABOVE
public static final java.lang.String POSITION_BOTH
public static final java.lang.String POSITION_BELOW
public static final java.lang.String TAB_REMOVAL_NONE
public static final java.lang.String TAB_REMOVAL_ALL
public static final java.lang.String TAB_REMOVAL_ALL_EXCEPT_LAST
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 CHILD_CREATION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DIMENSIONS_FROM_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey POSITION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TAB_REMOVAL_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichPanelTabbed()
protected RichPanelTabbed(java.lang.String rendererType)
Method Detail |
---|
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.lang.String getChildCreation()
public final void setChildCreation(java.lang.String childCreation)
childCreation
- the new childCreation valuepublic final java.lang.String getDimensionsFrom()
determines how the component will handle geometry management. This specifies where the dimensions of the panelTabbed come from:
<html:ul> <html:li>auto - either "disclosedChild" or "parent", depending on the container the panelTabbed is inside; if the panelTabbed is being stretched by its ancestor then "parent" will be used, otherwise "disclosedChild" will be used</html:li> <html:li>disclosedChild - the panelTabbed will get its dimensions from the currently disclosed showDetailItem child (as a result, the stretchChildren attribute on af:showDetailItem and any height assignment on the panelTabbed must be omitted or else it would mean a circular dependency and scrambled display in the browser)</html:li> <html:li>parent (the default) - the panelTabbed 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 (stretchChildren on af:showDetailItem will be honored)</html:li> </html:ul>public final void setDimensionsFrom(java.lang.String dimensionsFrom)
determines how the component will handle geometry management. This specifies where the dimensions of the panelTabbed come from:
<html:ul> <html:li>auto - either "disclosedChild" or "parent", depending on the container the panelTabbed is inside; if the panelTabbed is being stretched by its ancestor then "parent" will be used, otherwise "disclosedChild" will be used</html:li> <html:li>disclosedChild - the panelTabbed will get its dimensions from the currently disclosed showDetailItem child (as a result, the stretchChildren attribute on af:showDetailItem and any height assignment on the panelTabbed must be omitted or else it would mean a circular dependency and scrambled display in the browser)</html:li> <html:li>parent (the default) - the panelTabbed 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 (stretchChildren on af:showDetailItem will be honored)</html:li> </html:ul>dimensionsFrom
- the new dimensionsFrom valuepublic final java.lang.String getPosition()
public final void setPosition(java.lang.String position)
position
- the new position valuepublic final java.lang.String getTabRemoval()
This attribute supports these tabRemoval types:
<html:ul> <html:li> none - tab removal is not enabled.</html:li> <html:li> all - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed can be removed.</html:li> <html:li> allExceptLast - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed cannot be removed.</html:li> </html:ul>Choosing to remove a tab will cause an ItemEvent of type 'remove' to be launched. This event can be listened for on a showDetailItem using the itemListener attribute. It is up to the developer to handle this event and code the actual removal of the tab. This is because of the dynamic nature of the panelTabbed component, which may have dynamic children. This also allows a finer level of control by the developer, who can then choose a custom implementation that may (for example) include warning dialogs, and control of which tab gains focus after a tab is removed.
public final void setTabRemoval(java.lang.String tabRemoval)
This attribute supports these tabRemoval types:
<html:ul> <html:li> none - tab removal is not enabled.</html:li> <html:li> all - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed can be removed.</html:li> <html:li> allExceptLast - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed cannot be removed.</html:li> </html:ul>Choosing to remove a tab will cause an ItemEvent of type 'remove' to be launched. This event can be listened for on a showDetailItem using the itemListener attribute. It is up to the developer to handle this event and code the actual removal of the tab. This is because of the dynamic nature of the panelTabbed component, which may have dynamic children. This also allows a finer level of control by the developer, who can then choose a custom implementation that may (for example) include warning dialogs, and control of which tab gains focus after a tab is removed.
tabRemoval
- the new tabRemoval valuepublic final void addItemListener(ItemListener listener)
listener
- the item listener to addpublic final void removeItemListener(ItemListener listener)
listener
- the item listener to removepublic final ItemListener[] getItemListeners()
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXShowOne
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXShowOne
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |