Oracle Fusion Middleware Tag Reference for Oracle ADF Faces
11g Release 1 (11.1.1.9.0)

E52939-01

<af:panelSpringboard>

af:panelSpringboard panelSpringboard panel springboard

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

Unsupported agents: pda

The panelSpringboard control can be used to display a group of contents that belongs to a showDetailItem. An icon strip with icons representing the showDetailItem children along with the item's contents are displayed when in strip mode, and an grid of icons with no contents shown is displayed in grid mode. When the user selects an icon while the panelSpringboard is in strip mode, the panelSpringboard discloses the associated showDetailItem. When the user selects an icon while the panelSpringboard is in grid mode, this automatically causes the panelSpringboard to display in strip mode. Typically you would put one or more showDetailItem components inside of the panelSpringboard but you may also alternatively place a facetRef, group, iterator, or switcher inside of the panelSpringboard as long as these wrappers provide showDetailItem components as a result of their execution.

Attachment Mode

Attachment mode is currently unsupported for panelSpringboard.

Geometry Management

Code Example(s)

The following is an example of panelSpringboard.

<af:panelSpringboard id="ps1" displayMode="strip">
  <af:showDetailItem icon="/images/opportunities.png" textAndAccessKey="Opportunities"
                                     shortDesc="Opportunities Panel"" id="sdi1">
    <af:decorativeBox>
      <af:outputText value="content for opportunities goes here" id="tot1"/>
      <af:outputText value="Tab 1 Second Child" id="tot2"/>
    </af:decorativeBox>
  </af:showDetailItem>
  <af:showDetailItem icon="/images/architecture.png"  text="Architecture" id="sdi2" disclosed="true">
     <af:panelTabbed position="start">
                      ...
     </af:panelTabbed>
  </af:showDetailItem>
  <af:showDetailItem icon="/images/release.png" text="Release" id="sdi3">
    <af:decorativeBox>
      <af:outputText value="content for releases goes here" id="tot1"/>
      <af:outputText value="Tab 1 Second Child" id="tot2"/>
    </af:decorativeBox>
  </af:showDetailItem>
</af:panelSpringboard>
   

Events

Type Phases Description
oracle.adf.view.rich.event.SpringboardChangeEvent Apply Request Values,
Invoke Application
The springboardChange event is delivered when the springboard component changes the value of an attribute on the calendar. For example the displayMode changes.

Note that when these attributes are set by the springboard they are only set locally on the component, and the component no longer pulls the value from the EL expression. This is common practice, for example when you click on the +/- on a showDetail, disclosed is being set locally on the component to true/false by the framework. In order to save these local values you must use the change management framework.

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.

Attributes

Name Type Supports EL? Description
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.RichPanelSpringboard 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.
childCreation String No Valid Values: immediate, lazy, lazyUncached

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.
clientComponent boolean Yes 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.
contentDelivery String Yes Valid Values: immediate, 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.
displayMode String Yes Valid Values: strip, grid

This controls how the springboard is displayed. If displayMode is strip, the springboard renders as a strip with the details of one of the items shown. If displayMode is grid, the springboard renders as a grid of icons with no details shown.
dontPersist String[] Yes a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".
id String No the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
immediate boolean Yes whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is false (the default), the springboardChangeEvent will be delivered during the Invoke Application phase. When set to true, the event will be executed during the Apply Request Values phase.
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. 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.
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.
persist String[] Yes a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.
rendered boolean Yes 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. This text is commonly used by user agents to display tooltip help text, in which 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 it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
springboardChangeListener javax.el.MethodExpression Only EL a method reference to a springboard change listener
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.
visible boolean Yes 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