public class RichPanelDrawer
extends org.apache.myfaces.trinidad.component.UIXShowOne
implements javax.faces.component.behavior.ClientBehaviorHolder
The panelDrawer control can be used to display a group of showDetailItems. Drawer "handles", aka tabs, represent the showDetailItem children. Selecting a tab/handle opens the drawer and displays the associated showDetailItem. Whether a drawer is open is controlled by the disclosed attribute on the showDetailItem children. If none of the children are disclosed, the drawer is "closed" and it's normally shown as attached to the side of a container. Typically you would put one or more showDetailItem components inside of the panelDrawer but you may also alternatively place a facetRef, group, iterator, or switcher inside of the panelDrawer as long as these wrappers provide showDetailItem components as a result of their execution.
In some cases you must provide a height and width for the drawer. Please read the geometry management section for more info.
PanelDrawer has some limitations. The panelDrawer should not be nested one inside the other. Also, the panelDrawer uses a transparent popup, therefore there may be limitations as to what it can open over as some content may "bleed" through. For example it may not be able to open over pdf's in the page.
<section name="Geometry_Management"> <html:ul> <html:li>The drawer tries to float on the edge of the container without obstructing the content below. In some situations this may not work and you will need to lay out the drawer in a separate column, for example in a gridLayout or in a facet of panelStretchLayout. </html:li> <html:li>If the width and height attribute aren't set then by default the drawer will open to the size of the content. There are some things to keep in mind: <html:ul> <html:li>If the size of the content will change after the drawer is open (for example you toggle a showDetail inside the drawer which exposes new content) the drawer will not resize, in that case you must set the width and height attributes.</html:li> <html:li>Currently there is no conveyor belt/overflow support, so either you must set the height attribute or the height of the content must be tall enough to allow room for all the handles.</html:li> <html:li>If you are trying to stretch content in the drawer you need to set the width and height attributes, see showDetailItem info below.</html:li> </html:ul> </html:li> <html:li>This component uses <af:showDetailItem> to organize content. The <af:showDetailItem> will allow stretching if: <html:ul> <html:li>The panelDrawer has width and height attributes defined.</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:calendar></html:li> <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:panelGridLayout></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> </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. |
Modifier and Type | Field and Description |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ALIGN_ID_KEY |
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 String |
CONTENT_DELIVERY_IMMEDIATE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CONTENT_DELIVERY_KEY |
static String |
CONTENT_DELIVERY_LAZY_UNCACHED |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY
Deprecated.
|
static org.apache.myfaces.trinidad.bean.PropertyKey |
HEIGHT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MAXIMUM_HEIGHT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MAXIMUM_WIDTH_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static String |
POSITION_END |
static org.apache.myfaces.trinidad.bean.PropertyKey |
POSITION_KEY |
static String |
POSITION_LEFT |
static String |
POSITION_RIGHT |
static String |
POSITION_START |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static String |
SHOW_HANDLES_ALWAYS |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHOW_HANDLES_KEY |
static String |
SHOW_HANDLES_WHEN_OPEN |
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 |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WIDTH_KEY |
Modifier | Constructor and Description |
---|---|
|
RichPanelDrawer()
Construct an instance of the RichPanelDrawer.
|
protected |
RichPanelDrawer(String rendererType)
Construct an instance of the RichPanelDrawer.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
String |
getAlignId()
Gets The id of the component the drawer should align to.
|
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 |
getContentDelivery()
Gets This property is not currently supported for general use, and is intended to remain in its default lazyUncached state.
|
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getHeight()
Gets Specifies a candidate for the height of the drawer: a fixed CSS length, e.g.
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
String |
getMaximumHeight()
Gets Specifies a candidate for the maximum height of the drawer: a fixed CSS length, e.g.
|
String |
getMaximumWidth()
Gets Specifies a candidate for the maximum width of the drawer: a fixed CSS length, e.g.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
String |
getPosition()
Gets the position of the drawer relative to the container it's aligning to.
|
String |
getShortDesc()
Gets the short description of the component.
|
String |
getShowHandles()
Gets Allows control over whether to show the tab handle(s).
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
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.
|
String |
getWidth()
Gets Specifies a candidate for the width of the drawer: a fixed CSS length, e.g.
|
boolean |
isClientComponent()
Gets whether a client-side component will be generated.
|
boolean |
isVisible()
Gets the visibility of the component.
|
void |
setAlignId(String alignId)
Sets The id of the component the drawer should align to.
|
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 |
setContentDelivery(String contentDelivery)
Sets This property is not currently supported for general use, and is intended to remain in its default lazyUncached state.
|
void |
setCustomizationId(String customizationId)
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
void |
setHeight(String height)
Sets Specifies a candidate for the height of the drawer: a fixed CSS length, e.g.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setMaximumHeight(String maximumHeight)
Sets Specifies a candidate for the maximum height of the drawer: a fixed CSS length, e.g.
|
void |
setMaximumWidth(String maximumWidth)
Sets Specifies a candidate for the maximum width of the drawer: a fixed CSS length, e.g.
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setPosition(String position)
Sets the position of the drawer relative to the container it's aligning to.
|
void |
setShortDesc(String shortDesc)
Sets the short description of the component.
|
void |
setShowHandles(String showHandles)
Sets Allows control over whether to show the tab handle(s).
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
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 |
setVisible(boolean visible)
Sets the visibility of the component.
|
void |
setWidth(String width)
Sets Specifies a candidate for the width of the drawer: a fixed CSS length, e.g.
|
isChildSelected, queueEvent, visitTree
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, 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, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, 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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String CONTENT_DELIVERY_IMMEDIATE
public static final String CONTENT_DELIVERY_LAZY_UNCACHED
public static final String POSITION_START
public static final String POSITION_END
public static final String POSITION_LEFT
public static final String POSITION_RIGHT
public static final String SHOW_HANDLES_ALWAYS
public static final String SHOW_HANDLES_WHEN_OPEN
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 ALIGN_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MAXIMUM_WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HEIGHT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MAXIMUM_HEIGHT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey POSITION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_HANDLES_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public RichPanelDrawer()
protected RichPanelDrawer(String rendererType)
public final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
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.
public final void setShortDesc(String shortDesc)
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.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final String getAlignId()
public final void setAlignId(String alignId)
alignId
- the new alignId valuepublic final String getWidth()
If you don't set a value, the width will be driven off the content of the drawer
public final void setWidth(String width)
If you don't set a value, the width will be driven off the content of the drawer
width
- the new width valuepublic final String getMaximumWidth()
If you don't set a value, the maximumWidth will default to 100%.
public final void setMaximumWidth(String maximumWidth)
If you don't set a value, the maximumWidth will default to 100%.
maximumWidth
- the new maximumWidth valuepublic final String getHeight()
If you don't set a value, the height will be driven off the content of the drawer
public final void setHeight(String height)
If you don't set a value, the height will be driven off the content of the drawer
height
- the new height valuepublic final String getMaximumHeight()
If you don't set a value, the maximumHeight will default to 100%.
public final void setMaximumHeight(String maximumHeight)
If you don't set a value, the maximumHeight will default to 100%.
maximumHeight
- the new maximumHeight valuepublic final String getContentDelivery()
Determines whether content is delivered with the initial page. When contentDelivery is "immediate", tab content is inlined into the initial page. By default, contentDelivery is lazyUncached.
public final void setContentDelivery(String contentDelivery)
Determines whether content is delivered with the initial page. When contentDelivery is "immediate", tab content is inlined into the initial page. By default, contentDelivery is lazyUncached.
contentDelivery
- the new contentDelivery valuepublic final String getPosition()
public final void setPosition(String position)
position
- the new position valuepublic final String getShowHandles()
public final void setShowHandles(String showHandles)
showHandles
- the new showHandles valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,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(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 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