Summary

Tag Name: <af:panelSpringboard>
Java Class: oracle.adf.view.rich.component.rich.layout.RichPanelSpringboard
Component Type: oracle.adf.RichPanelSpringboard
Unsupported Agent(s): 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.

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".
  • PanelSpringboard only animates when it it being stretched. When it is not being stretched (flow mode) the content is rendered in a table element which cannot be positioned via css and does not allow for animation of the content area.
  • This component uses <af:showDetailItem> to organize content into each item body panel. The <af:showDetailItem> will allow stretching if:
    • The panelSpringboard's can be stretched by its parent
    • The showDetailItem 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:panelSpringboard>
    • <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>

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>

Supported Client Events for Client Behaviors

  • click
  • contextMenu
  • dblClick
  • mouseDown
  • mouseMove
  • mouseOut
  • mouseOver
  • mouseUp
  • propertyChange

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 event 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
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.
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.
customizationId String Yes 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.
displayMode String Yes Valid Values: strip, grid
Default Value: strip

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. 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).
immediate boolean Yes Default Value: false

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