<af:panelDrawer>

af:panelDrawer panelDrawer panel drawer

UIComponent class: oracle.adf.view.rich.component.rich.layout.RichPanelDrawer
Component type: oracle.adf.RichPanelDrawer

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.

Geometry Management

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.
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:
- 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.
- 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.
- If you are trying to stretch content in the drawer you need to set the width and height attributes, see showDetailItem info below.
This component uses <af:showDetailItem> to organize content. The <af:showDetailItem> will allow stretching if:
- The panelDrawer has width and height attributes defined.
- It contains a single child
- It has stretchChildren="first" specified
- The child has no width, height, margin, border, and padding
- The child must be capable of being stretched
Examples of components that can be stretched inside of a <af:showDetailItem> include:
- <af:calendar>
- <af:decorativeBox>
- <af:panelAccordion>
- <af:panelBox>
- <af:panelCollection>
- <af:panelGridLayout>
- <af:panelGroupLayout layout="scroll">
- <af:panelGroupLayout layout="vertical">
- <af:panelHeader>
- <af:panelSplitter>
- <af:panelStretchLayout>
- <af:panelTabbed>
- <af:region>
- <af:table>
- <af:tree>
- <af:treeTable>

Code Example(s)

The following is an example of panelDrawer.

<af:panelDrawer id="pd1">
  <af:showDetailItem text="ADF Faces Components" id="sdi1"
                     icon="/images/comps_ena.png"
                     hoverIcon="/images/comps_ovr.png"
                     depressedIcon="/images/comps_sel.png" >
    <af:panelHeader text="ADF Faces Components First Child" id="ph1"/>
    <af:panelHeader text="ADF Faces Components Second Child" id="ph2"/>
  </af:showDetailItem>
  <af:showDetailItem text="Architecture" disabled="true" id="sdi2"
                     disabledIcon="/images/arch_dis.png">
    <af:panelHeader text="Architecture First Child" id="ph3"/>
    <af:panelHeader text="Architecture Second Child" id="ph4"/>
  </af:showDetailItem>
  <af:showDetailItem text="Release" id="sdi3"
                     icon="/images/rel_ena.png"
                     hoverIcon="/images/rel_ovr.png"
                     depressedIcon="/images/rel_sel.png">
    <af:panelHeader text="Release First Child" id="ph5"/>
    <af:panelHeader text="Release Second Child" id="ph6"/>
  </af:showDetailItem>
</af:panelDrawer>

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.

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.

Attributes

Name	Type	Supports EL?	Description
alignId	String	Yes	The id of the component the drawer should align to. This is necessary because sometimes the drawer cannot be the direct child of the component it is meant to align to, but in general the drawer should be as close a descendent of the align component as possible. If alignId is not set the default is the drawer's parent.
attributeChangeListener	javax.el.MethodExpression	Only EL	a method reference to an attribute change listener. 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.
binding	oracle.adf.view.rich.component.rich.layout.RichPanelDrawer	Only EL	an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
clientComponent	boolean	Yes	Default Value: false 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. For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml.
contentDelivery	String	Yes	Valid Values: immediate, lazyUncached Default Value: lazyUncached This property is not currently supported for general use, and is intended to remain in its default lazyUncached state. It is currently only used when the page is rendered in attachment mode, and the contentDelivery is forced to an immediate setting. 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.
customizationId	String	Yes	This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
height	String	Yes	Specifies a candidate for the height of the drawer: a fixed CSS length, e.g. "px" a "%" length: make the drawer a fraction of the align element height If you don't set a value, the height will be driven off the content of the drawer
id	String	No	the identifier for the component. Every component may be named by a component identifier that must conform to the following rules: They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ). Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
inlineStyle	String	Yes	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.
maximumHeight	String	Yes	Default Value: 100% Specifies a candidate for the maximum height of the drawer: a fixed CSS length, e.g. "px" a "%" length: make the drawer a fraction of the align element height. If you don't set a value, the maximumHeight will default to 100%.
maximumWidth	String	Yes	Default Value: 100% Specifies a candidate for the maximum width of the drawer: a fixed CSS length, e.g. "px" a "%" length: make the drawer a fraction of the align element width. If you don't set a value, the maximumWidth will default to 100%.
partialTriggers	String[]	Yes	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.
position	String	Yes	Valid Values: start, end, left, right Default Value: end the position of the drawer relative to the container it's aligning to. Defaults to "end". When using right/left the position will remain right or left regardless of the language, for example it will remain right or left even in right to left languages like Hebrew and Arabic. Use start/end if the alignment should change depending on the language.
rendered	boolean	Yes	Default Value: true whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDesc	String	Yes	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.
showHandles	String	Yes	Valid Values: always, whenOpen Default Value: always Allows control over whether to show the tab handle(s). When the handles attribute is set to "whenOpen" then the handles aren't shown when the drawer is closed, and the app developer must programmatically open the drawer by setting the "disclosed" attribute to "true" on one of the showDetailItems.
styleClass	String	Yes	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'.
unsecure	java.util.Set	Yes	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.
visible	boolean	Yes	Default Value: true 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. Not supported on the following renderkits: org.apache.myfaces.trinidad.core
width	String	Yes	Specifies a candidate for the width of the drawer: a fixed CSS length, e.g. "px" a "%" length: make the drawer a fraction of the align element width. If you don't set a value, the width will be driven off the content of the drawer

Name

Type

Supports EL?

Description

alignId

String

Yes

The id of the component the drawer should align to. This is necessary because sometimes the drawer cannot be the direct child of the component it is meant to align to, but in general the drawer should be as close a descendent of the align component as possible. If alignId is not set the default is the drawer's parent.

attributeChangeListener

javax.el.MethodExpression

Only EL

a method reference to an attribute change listener. 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.

binding

oracle.adf.view.rich.component.rich.layout.RichPanelDrawer

Only EL

an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.

clientComponent

boolean

Yes

Default Value: false

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.
For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml.

contentDelivery

String

Yes

Valid Values: immediate, lazyUncached
Default Value: lazyUncached

This property is not currently supported for general use, and is intended to remain in its default lazyUncached state. It is currently only used when the page is rendered in attachment mode, and the contentDelivery is forced to an immediate setting.

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.

customizationId

String

Yes

This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

height

String

Yes

Specifies a candidate for the height of the drawer:

a fixed CSS length, e.g. "px"
a "%" length: make the drawer a fraction of the align element height

If you don't set a value, the height will be driven off the content of the drawer

String

the identifier for the component. Every component may be named by a component identifier that must conform to the following rules:

They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ).
Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).

inlineStyle

String

Yes

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.

maximumHeight

String

Yes

Default Value: 100%

Specifies a candidate for the maximum height of the drawer:

a fixed CSS length, e.g. "px"
a "%" length: make the drawer a fraction of the align element height.

If you don't set a value, the maximumHeight will default to 100%.

maximumWidth

String

Yes

Default Value: 100%

Specifies a candidate for the maximum width of the drawer:

a fixed CSS length, e.g. "px"
a "%" length: make the drawer a fraction of the align element width.

If you don't set a value, the maximumWidth will default to 100%.

partialTriggers

String[]

Yes

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.

position

String

Yes

Valid Values: start, end, left, right
Default Value: end

the position of the drawer relative to the container it's aligning to. Defaults to "end". When using right/left the position will remain right or left regardless of the language, for example it will remain right or left even in right to left languages like Hebrew and Arabic. Use start/end if the alignment should change depending on the language.

rendered

boolean

Yes

Default Value: true

whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.

shortDesc

String

Yes

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.

showHandles

String

Yes

Valid Values: always, whenOpen
Default Value: always

Allows control over whether to show the tab handle(s). When the handles attribute is set to "whenOpen" then the handles aren't shown when the drawer is closed, and the app developer must programmatically open the drawer by setting the "disclosed" attribute to "true" on one of the showDetailItems.

styleClass

String

Yes

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'.

unsecure

java.util.Set

Yes

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.

visible

boolean

Yes

Default Value: true

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.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core

width

String

Yes

Specifies a candidate for the width of the drawer:

a fixed CSS length, e.g. "px"
a "%" length: make the drawer a fraction of the align element width.

If you don't set a value, the width will be driven off the content of the drawer