Summary

Tag Name:<af:panelTabbed>
Java Class:oracle.adf.view.rich.component.rich.layout.RichPanelTabbed
Component Type:oracle.adf.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.

Geometry Management

  • 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".
  • This component uses <af:showDetailItem> to organize content into each tab body panel. The <af:showDetailItem> will allow stretching if:
    • The panelTabbed has dimensionsFrom="parent"
    • 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:decorativeBox>
    • <af:panelAccordion>
    • <af:panelBox>
    • <af:panelCollection>
    • <af:panelGroupLayout layout="scroll">
    • <af:panelGroupLayout layout="vertical">
    • <af:panelHeader>
    • <af:panelSplitter>
    • <af:panelStretchLayout>
    • <af:panelTabbed>
    • <af:region>
    • <af:table>
    • <af:tree>
    • <af:treeTable>
    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:
    • <af:panelBorderLayout>
    • <af:panelFormLayout>
    • <af:panelGroupLayout layout="default">
    • <af:panelGroupLayout layout="horizontal">
    • <af:panelLabelAndMessage>
    • <af:panelList>
    • <trh:tableLayout>
There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor:
  • You can specify dimensionsFrom="disclosedChild" for the panelTabbed to be as tall as the currently-disclosed af:showDetailItem. When using this "disclosedChild" setting, the stretchChildren attribute on af:showDetailItem and any height assignment on the panelTabbed must be omitted or else there would be a competing assignment for how tall the component will be.
  • You can also specify dimensionsFrom="parent" to make the panelTabbed get its dimensions from the inlineStyle and if not provided from there then from its parent component or if not provided from the parent then from the skin (stretchChildren on af:showDetailItem will be honored).
  • Using dimensionsFrom="auto" will choose either "disclosedChild" or "parent" depending on whether the panelTabbed is being stretched by its parent.

Supports Compressed Layout

PanelTabbed supports compressed layout modes of overflow or conveyor belt. Which compressed layout mode is used depends on the assignment of the -tr-layout-type skinning key (see skinning documentation). In order for a compressed layout component to work properly, it must be part of a supported layout on the page.

A compressed layout (overflow or conveyor belt) component requires that it is either:

  • in a container that stretches its children, or
  • in a container that has a set width.

Under these circumstances, when the compressed layout component is larger than the parent container, the compressed layout component will display buttons to support its particular compressed layout mode (overflow or conveyor belt).

For overflow compressed layout mode, selecting the overflow button(s) will show a popup containing the items that didn't fit on the page.

For conveyor belt compressed layout mode, selecting the conveyor belt buttons will roll the shown content. In addition, there is a conveyor belt droplist button that shows a popup containing all of the managed items.

Setting up a compressed layout (overflow or conveyor belt) component with the following layouts is not supported. If you use one of these layouts, you may have unexpected and inconsistent results:

  • in a container that does not stretch its children.
  • in a container that displays multiple children horizontally without explicit sizes for each child. For example, a panelGroupLayout with layout='horizontal' would be invalid, but panelSplitter is OK because it has an explicitly set splitter position.
  • setting the compressed layout component with a styleClass or inlineStyle that assigns a percentage width value. Note that this includes assigning styleClass='AFStretchWidth' on a compressed layout component.

At this time overflow and the conveyor belt only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

Screenshot(s)

panelTabbed screenshot
A panelTabbed component.

Code Example(s)

The following is an example of panelTabbed.

<af:panelTabbed id="pt1">
  <af:showDetailItem text="ADF Faces Components" id="sdi1">
    <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">
    <af:panelHeader text="Architecture First Child" id="ph3"/>
    <af:panelHeader text="Architecture Second Child" id="ph4"/>
  </af:showDetailItem>
  <af:showDetailItem text="Release" id="sdi3">
    <af:panelHeader text="Release First Child" id="ph5"/>
    <af:panelHeader text="Release Second Child" id="ph6"/>
  </af:showDetailItem>
</af:panelTabbed>

The following example renders with the tab bar appearing only above the contents.

<af:panelTabbed>
  <af:showDetailItem text="ADF Faces Components" position="above">
    <af:panelHeader text="ADF Faces Components First Child"/>
    <af:panelHeader text="ADF Faces Components Second Child"/>
  </af:showDetailItem>
  <af:showDetailItem text="Architecture">
    <af:panelHeader text="Architecture First Child"/>
    <af:panelHeader text="Architecture Second Child"/>
  </af:showDetailItem>
  <af:showDetailItem text="Release" disabled="true">
    <af:panelHeader text="Release First Child"/>
    <af:panelHeader text="Release Second Child"/>
  </af:showDetailItem>
</af:panelTabbed>

Supported Client Events for Client Behaviors

  • click (default)
  • contextMenu
  • dblClick
  • mouseDown
  • mouseMove
  • mouseOut
  • mouseOver
  • mouseUp
  • propertyChange

Events

Type Phases Description
oracle.adf.view.rich.event.ItemEventApply Request ValuesThe 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.AttributeChangeEventInvoke 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
attributeChangeListenerjavax.el.MethodExpressionOnly 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.
bindingoracle.adf.view.rich.component.rich.layout.RichPanelTabbedOnly 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.
childCreationStringNo Valid Values: immediate, lazy, lazyUncached
Default Value: immediate

Controls when the children components are created. Introduces a server-side performance enhancement by postponing construction of the components under the undisclosed disclosure components.

The non-immediate settings will only work when the children components are created via the UIXComponentELTag and are not in a stamping component (like af:iterator).

Legal values are:
  • "immediate": Children components will be created immediately
  • "lazy": Children will be populated when the disclore component is disclosed and will be kept in memory thereafter.
  • "lazyUncached": Children will be populated when the disclore component is disclosed and may be removed when undisclosed.
clientComponentbooleanYes 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.
customizationIdStringYes This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
dimensionsFromStringYes Valid Values: auto, disclosedChild, parent
Default Value: parent

determines how the component will handle geometry management. This specifies where the dimensions of the panelTabbed come from:

  • 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
  • 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)
  • parent - 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)

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be "auto". Otherwise, the default value will be "parent".

idStringNo 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).
inlineStyleStringYes 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.
maxTabSizeStringYes Default Value: infinity

the maximum tab size that is rendered by default when the tab bar has more than enough space. Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%").
minTabSizeStringYes Default Value: 0px

the minimum tab size that a tab can shrink to before using a compressed layout manager (overflow or conveyor belt). Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%").
partialTriggersString[]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.
positionStringYes Valid Values: above, both, below, start, end, left, right
Default Value: above

the position of the tab bar. Defaults to "above". In accessibility screen reader mode, tab bar position is always "above". 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.

At this time overflow and/or the conveyor belt only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

At this time the tabRemoval attribute only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

renderedbooleanYes 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.
shortDescStringYes 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.

styleClassStringYes 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'.
tabRemovalStringYes Valid Values: none, all, allExceptLast
Default Value: none

determines if tab removal is enabled.

This attribute supports these tabRemoval types:

  • none - tab removal is not enabled.
  • all - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed can be removed.
  • allExceptLast - tab removal is enabled on all tabs, regardless if they are disclosed. The last tab in the panelTabbed cannot be removed.

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.

At this time the tabRemoval attribute only works when the position attribute is "above", "below", or "both". It does not work when the position attribute is "start", "end", "right", or "left".

truncationStyleStringYes Valid Values: none, ellipsis
Default Value: none

the truncation style applied to tab text when the text size exceeds the tab size.
unsecurejava.util.SetYes 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.
visiblebooleanYes 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