Customizable Components (HTML) Library - Show Detail Frame (HTML) Component

Use the Show Detail Frame (HTML) component to include a Show Detail Frame (HTML), which is a component that can render a border or chrome around its child component and thereby provide UI controls to customize the display of the child component.

You can maximize and minimize the child element by using the options available on the header of the Show Detail Frame (HTML).

In addition, you can customize the menu on the header by adding your own UI controls by using facets of the Show Detail Frame (HTML) tag. A list of options, available as a drop-down list on the Show Detail Frame (HTML) header, allows you to control the display of the child component.

If you place Show Detail Frame (HTML) components inside a Panel Customizable (HTML) component, then in addition to maximizing and minimizing the display, you can also move the child components up and down or to the right and left.

Example

<custh:showDetailFrame id="sdf1" text="showDetailFrame 1">

Common Attributes

Element Description

id

Specifies the unique identifier for the component on the page. This attribute is populated with a unique value by default when you add 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 ('-')

rendered

Specifies 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). The default value is true.

text

Specifies a title that will be displayed in the Show Detail Frame (HTML) header.

icon

Specifies the path where the image for the icon is stored if you decide to add an icon on the header of the Show Detail Frame (HTML) component.

Appearance Attributes

Element Description

text

Specifies the title that will be displayed in the Show Detail Frame (HTML) header.

shortDesc

Provides a short description of this component.

icon

Specifies the path where the image for the icon is stored if you decide to add an icon on the header of the Show Detail Frame (HTML) component.

background

Provides a means of applying a different look-and-feel for this Show Detail Frame (HTML) instance, working in conjunction with the skin CSS. Available values are light, medium, and dark. Default value is medium.

displayHeader

Indicates whether the component's header is displayed. Available values are true and false. Default value is true.

Note: If you have exposed some actions on the component, and if those actions can be displayed, then even if this attribute is set to false, a toolbar is displayed when you move the mouse over the component area.

expansionMode

Represents the default state of the Show Detail Frame (HTML). Available values are maximized, normal, and minimized. Default value is normal.

In the minimize mode, only the header is displayed. In the maximize mode, the component occupies the entire space allocated to its root parent, which occurs highest in the hierarchy. The root parent could be either a Show Detail Frame (HTML) or a Panel Customizable (HTML) component.

rendered

Specifies whether the component will be rendered or not. Available values are true and false. The default value is true.

showMoveAction

Renders a Move command on the Actions menu for Show Detail Frame (HTML) components placed inside a Panel Customizable (HTML) component. Available options are menu and none. Default value is menu.

showMinimizeAction

Renders a Minimize icon on the Show Detail Frame (HTML) header that collapses and restores the Show Detail Frame (HTML). Available values are chrome and none. Default value is chrome.

showMaximizeAction

Renders a Maximize command on the component's Actions menu for Show Detail Frame (HTML) components placed inside a Panel Customizable (HTML) component so that the child component can take advantage of the entire Panel Customizable (HTML) area for display. Available values are menu, chrome, both, and none. Default value is menu.

Style Attributes

Element Description

contentStyle

Specifies the CSS style to apply to the Show Detail Frame (HTML) content area. Manually enter any style in compliance with CSS version 2.0 or later.

styleClass

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.

inlineStyle

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.

Behavior Attributes

Element Description

partialTriggers

The IDs of the components that should trigger a partial update. This component will listen on the trigger components. If a trigger component 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 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.

disclosureListener

Specifies a method reference to a disclosure listener. A disclosure event is fired when the user maximizes or minimizes the Show Detail Frame (HTML) component. Specify a method reference of type javax.el.MethodExpression.

Advanced Attributes

Element Description

binding

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

attributeChangeListener

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. Specify a method reference of type javax.el.MethodExpression.

Customization Attributes

Element Description

customizationAllowed

Specifies whether customizations are allowed on this component. Available values are true and false. The default value is true.

customizationAllowedBy

Specifies the roles for which customization is enabled.

The Expression Builder option available when setting these attributes allows you to bind a Show Detail Frame (HTML) instance to a managed bean property.


Other Attributes

Element Description

customizationId

This attribute is deprecated. It will be removed in the next release. Use the id attribute.