B Composer Component Properties and Files

Common Attributes

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

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

Appearance Attributes

sourceViewPosition

String

Yes

The position of the Structure view pane displaying components in a tree structure. Valid values are bottom, end, start, and top. Default value is top.

For more information, see the section, Section 16.6, "Editing Capabilities in Structure View in Page Edit Mode.".

sourceViewSize

String

Yes

The height or width of the Structure view pane in pixels.

Use this to specify height if the sourceViewPosition is set to top or bottom, or to specify width if sourceViewPosition is set to start or end.

Since the default for sourceViewPosition is top, the pane has a default height of 200 pixels.

Alternatively, the resize handler on the edge of the Structure view pane enables users to alter the height or width of the pane at runtime.

editModeView

Specifies the default view in which to open a page in Composer. Valid options are design and source. Default value is design.

If you select source, the page is opened in Structure view in Composer. If you select design, the page is opened in Design view in Composer if the value design or all is specified for the designViews attribute. Else the page is displayed in Add Content view.

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

toolbarLayout

String

Yes

The elements to be displayed on the Composer toolbar. This attribute can take a space-separated list of elements.

The built in strings the component recognizes are message, stretch, statusindicator, newline, menu, addonpanels, stretch, help, and button.

For more information about using this attribute, see Section 19.10, "Customizing the Composer Toolbar."

Style Attributes

styleClass

String

Yes

The 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

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 must create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Advanced Attributes

binding

oracle.adf.view.page.editor.component.PageCustomizable

Supports only EL

An EL reference that stores 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.

sourceViewNodeActions

String

Yes

The name of the JPSX file to be called if you want to display custom actions against task flows in the component navigator in Composer Structure view.

The sourceViewNodeAction attribute can take the name of a JSPX file or an EL value that evaluates to a JSPX file name.

For information about using this attribute, see Section 20.4, "Enabling Custom Actions that Display on Task Flows in the Component Navigator."

allowLabel

Boolean

Yes

Specifies whether label creation must be enabled in the Customization Manager. When allowLabel is set to true, a Save and Label button is displayed on the Composer toolbar. For more information, see Section 16.5.15, "Manage Application Customizations."

This attribute is relevant only if you have configured sandbox support in your application.

catalog

String

Yes

The resource catalog to be used as the default one for the application page. Provide the catalog definition file name.

For more information about using multiple resource catalogs, see Chapter 14, "Developing Resource Catalogs."

allowEL

Boolean

No

Specifies whether or not EL can be run in application pages. Default is true.

This setting overrides the <pe:allow-el> setting in adf-config.xml.

For more information, see Section 19.4.2, "How to Protect Expression Language."

protectEL

Boolean

No

Specifies whether or not EL in form elements is read-only. Default is false.

This setting overrides the <pe:protect-el> setting in adf-config.xml.

For more information, see Section 19.4.2, "How to Protect Expression Language."

designViews

String

Yes

Specifies the views available to a user in Composer. By default, Add Content and Structure views are available for backward compatibility.

This attribute can take a space-separated list of elements. Available options are design, add-content, source, select, preview, and all.

If you set the value as all, all the views are rendered except Add Content, and Design view becomes the default view in Composer.

If the designViews attribute is set, it overrides the designViews setting in adf-config.xml. However, if this attribute is set to an EL that returns null, then the adf-config.xml setting for designViews is used.

For more information see Section 19.11, "Enabling Direct Select in Design or Add Content View."

Customization Attributes

customizationAllowed

Boolean

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

customizationAllowedBy

String

Specifies the roles for which customization is enabled.

Common Attributes

id

String

Yes

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

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

In a secured application, to enable the Edit link or button only for selected users based on specific criteria, you can specify an EL value for the rendered attribute.

Note: In a secured application, it is recommended that you check all users' privileges and enable the Edit link or button only for privileged users. Unauthenticated users who stumble into page Edit mode can change component properties.

Behavior Attribute

immediate

Boolean

Yes

Specifies whether data validation - client-side or server-side - must be skipped when events are generated by this component. When immediate is true, the command's action and ActionListeners, including the default ActionListener provided by the JavaServer Faces implementation, is executed during the Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase. Because validation runs during Process Validators (after Apply Request Values, but before Invoke Application), setting immediate to true skips validation.

Advanced Attributes

binding

oracle.adf.view.page.editor.component.ChangeModeLink

or

oracle.adf.view.page.editor.component.ChangeModeButton

Supports only EL

An EL reference that stores the component instance in 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.

Customization Attributes

customizationAllowed

Boolean

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

customizationAllowedBy

String

Specifies the roles for which customization is enabled.

Other Attribute

customizationId

This attribute has been deprecated. Use the id attribute.

Common Attributes

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

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

The rendering of a component can also be defined at runtime using the Show Component and Hide Component options.

type

String

Yes

Specifies the layout to be used for the page. You can choose from a list of eight predefined layouts. For more information, see Table B-5.

Default value is threeColumn.

You can define customization restrictions on a Layout Customizable component. Specifically, if you place a restriction on the type attribute, then layout changer options are shown as disabled and users cannot use them to change the page layout. For more information, see Chapter 22, "Modifying Default Security Behavior of Composer Components."

Appearance Attributes

text

String

Yes

Specifies the text to be displayed for the Change Layout menu.

Use the text attribute to provide a descriptive label for the Layout Customizable component so that the component is clearly visible on the page at runtime.

For example:

text="Change Layout"

accessKey

Char

Yes

A character used to gain quick access to this button. For accessibility reasons, this functionality is not supported in screen reader mode.

If the same access key appears in multiple input fields in the same page of output, the rendering user agent cycles among the elements accessed by the similar keys. Note that user agents are inconsistent about dealing with two links having same access key, and so the cycling behavior is dependent on what the user agent provides.

This attribute is sometimes referred to as the "mnemonic".

The character specified by this attribute must exist in the Text attribute of this button instance. If it does not, the user receives no visual indication of the existence of the accessKey. The easiest, and most convenient way to specify both the text and the mnemonic together is to use textAndAccessKey.

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 sets focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems sets focus when you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems set focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.

showIcon

Boolean

Yes

Specifies whether the default Change Layout icon is visible or not.

The default value is true.

showLayoutChanger

Boolean

Yes

Specifies whether the Change Layout icon or text must be displayed.

The default value is true.

When set to true, the runtime behavior of the layout changer is as follows:

• Displayed in View mode.Displayed in Edit mode.

  It is always displayed in Edit mode, even if the value of the showLayoutChanger attribute is false.

• If there is a security or MDS restriction on the Layout Customizable component, then the layout changer is not displayed in View or Edit modes.

showTypes

String

Yes

Specifies the names of predefined layouts that must be displayed in the layout changer. Use this attribute to control the layout options displayed to users. You can provide a space-separated list of layout types. By default, all eight layouts are displayed when a user clicks the Change Layout icon or link.

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, for example, Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

Style Attributes

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.

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 must create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Advanced Attribute

binding

oracle.adf.view.page.editor.component.LayoutCustomizable

Supports only EL

An EL reference that stores the component instance in 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.

For example:

binding="#{yourManagedBean.Binding}"

Customization Attributes

customizationAllowed

Boolean

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

customizationAllowedBy

String

Specifies the roles for which customization is enabled.

Other Attribute

customizationId

This attribute has been deprecated. Use the id attribute.

Common Attributes

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

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

The rendering of a component can also be defined at runtime using the Show Component and Hide Component options.

halign

String

Yes

Specifies the horizontal alignment of child components.

You can set horizontal alignment on child components only if the Panel Customizable component has a horizontal or vertical layout.

Available values are center, end, left, right, and start. Default value is start.

valign

String

Yes

Specifies the vertical alignment of child components.

You can set vertical alignment on child components only if the Panel Customizable component has a horizontal layout.

Available values are baseline, bottom, middle, and top. Default value is top.

shortDesc

String

Yes

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

layout

String

Yes

Specifies how the children of the Panel Customizable must be laid out.

Available options are horizontal, vertical, scroll, stretch, and auto. The default value is vertical.

Depending on the value of the layout attribute, child components are laid out as follows:

• If you select vertical, then the child components are displayed one below the other and can be moved either up or down within the layout.

• If you select horizontal, then the child components are displayed adjacent to each other and can be moved either to the left or right within the layout.

• If you select scroll, then the child components are displayed one below the other, with scroll bars displayed if content overflows.

• If you select stretch, then the first child component is stretched to fill up available space in the Panel Customizable component. Subsequent child components are ignored. However, they are not removed from the page.

  The Add icons for adding new Panel Customizable components adjacent to the selected one are not enabled if you set layout to stretch.

• If you select auto, the child component is stretched only if the Panel Customizable is stretched by its parent. If not, the content scrolls.

Style Attributes

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.

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 attribute's CSS properties do not affect the DOM element you want affected, then you must create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Behavior Attributes

allowAction

Boolean

Yes

Determines whether this component allows addition of child components, dragging and dropping Show Detail Frame components inside and from it, and rearranging child components at runtime. It also determines whether the Add Box icons (that enable users to add Box components adjacent to the component) must be rendered on the component.

Available values are none and all. The default value is all.

Note: You can also set this attribute while defining component security in the application's adf-config.xml file. For more information, see Section 22.5, "Applying Action-Level Restrictions on Panel Customizable and Show Detail Component Actions."

showEditAction

Boolean

Yes

While in Edit mode, in Add Content or Design view, renders an Edit icon on the Panel Customizable header that enables users to edit component properties at runtime. Available values are true and false. Default value is true.

This is relevant only in a Composer-enabled page, that is, if the Panel Customizable component is nested within a Page Customizable component.

showSplitAction

Boolean

Yes

In Add Content or Design view of a page in Edit mode, renders the Add Box icons on the Panel Customizable header that enable users to add Box components above, below, to the left, or right of the selected component. Available values are true and false. Default value is true.

This is relevant only in a Composer-enabled page, that is, if the Panel Customizable component is nested within a Page Customizable component. However, the Add Box icons are not displayed on the root Panel Customizable component.

Although the default value for this attribute is true, the Add Box icons are not displayed on a component that is stretched.

showTabAction

Boolean

Yes

In Add Content or Design view of a page in Edit mode, renders the Add a Tab Set or a Tab icon on the Panel Customizable header that enables users to add a tabs to the page. Available values are true and false. Default value is false.

This is relevant only in a Composer-enabled page, that is, if the Panel Customizable component is nested within a Page Customizable component.

Advanced Attributes

binding

oracle.adf.view.page.editor.component.PanelCustomizable

Supports only EL

An EL reference that stores the component instance in 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.

Customization Attributes

customizationAllowed

Boolean

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

customizationAllowedBy

String

Specifies the roles for which customization is enabled.

Other Attribute

customizationId

This attribute has been deprecated. Use the id attribute.

Common Attributes

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

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

The rendering of a component can also be defined at runtime using the Show Component and Hide Component options.

text

String

Yes

A title for the Show Detail Frame component.

You can change the style of this text using the headerStyle attribute.

icon

String

Yes

If you decide to add an icon on the header of the Show Detail Frame component, then this specifies the URI for the image to be used.

For example:

icon="http://source-pc/images/accessability.gif"

Note: An image that is stored at the document root does not require a full path. For example:

icon="detail.gif"

Appearance Attributes

text

String

Yes

A title for the Show Detail Frame component.

You can change the style of this text using the headerStyle attribute.

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, for example, Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

icon

String

Yes

If you decide to add an icon on the header of the Show Detail Frame component, then this specifies the URI for the image to be used.

For example:

icon="http://source-pc/images/accessability.gif"

Note: An image that is stored at the document root does not require a full path. For example:

icon="detail.gif"

background

String

Yes

Working with the skin CSS, provides a means of applying a different look and feel for this Show Detail Frame instance.

Available values are light, medium, dark, and coreDefault. The default value is medium.

The coreDefault value is similar to medium, but additionally it provides a rounded border for the container and renders a shadow. The background in this case would be similar to that of an ADF Faces panelBox component.

displayHeader

Boolean

Yes

Indicates whether the header of the Show Detail Frame is displayed.

The default value is true.

If you choose to set displayHeader to false and if you have exposed some actions on the component, then a toolbar is displayed when you move the mouse over the component area. The toolbar contains a drop down icon, which displays a menu of available options. This toolbar displays only in Edit mode, if there are actions available on the component.

displayShadow

Boolean

Yes

Specifies whether a shadow is cast by the Show Detail Frame component.

The default value is false.

expansionMode

String

Yes

The default state of the Show Detail Frame.

Available values are minimized and normal. The default display mode is normal.

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

The rendering of a component can also be defined at runtime using the Show Component and Hide Component options.

Actions Attributes

displayActions

String

Yes

Specifies when seeded interactions are displayed.

Available options are onHover and always. The default is always.

inheritGlobalActions

Boolean

Yes

This attribute is of significance if you add child custom action components, and the attribute specifies whether the global action value of a custom action must override the local value.

The default value is false.

For information about global custom actions, see Section 20.3.2.2, "Defining Custom Actions at the Global Level."

showMoveAction

String

Yes

Specifies whether the Move action is available for the component.

Available values are:

• menu—Move action is displayed in the Actions menu, and the action to drag and drop the header is enabled

• none—User can move the component by clicking the header and using drag and drop

• disabled—Component cannot be moved

The default value is menu.

Note: The disabled option is applicable only in View mode.

showRemoveAction

String

Yes

Renders a Remove icon on the Show Detail Frame header. Clicking this icon removes the component from the page.

Available values are chrome and none. The default value is none.

Note: In page Edit mode, the Remove icon appears regardless of this setting, provided other restrictions have not been applied.

showResizer

String

Yes

Specifies whether a resize handle is displayed on the lower right corner of the Show Detail Frame. You can alter only the height of a Show Detail Frame while resizing it.

Available values are never and always. The default value is always.

showMinimizeAction

String

Yes

Specifies whether the minimize action is displayed on the header.

Available values are chrome and none. The default is chrome.

showEditAction

Boolean

Yes

While in Edit mode, in Add Content or Design view, renders an Edit icon on the Show Detail Frame header that enables you to edit component properties at runtime. Default value is true.

This is relevant only in a Composer-enabled page, that is, if the Show Detail Frame component is nested within a Page Customizable component.

Style Attributes

contentStyle

String

Yes

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

The CSS styles in this attribute are commonly used to define the height and background color of the Show Detail Frame. For example, height:200px; background-color:green;

Note: If the Show Detail Frame component is nested inside a Panel Customizable component with a horizontal layout, you must specify a width for the Show Detail Frame component to ensure that it is rendered in page View mode.

styleClass

String

Yes

The 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

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 must create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

headerStyle

String

Yes

The CSS style to apply to the Show Detail Frame title that is displayed on the header. Manually enter any style in compliance with CSS version 2.0 or later.

The CSS styles in this attribute are commonly used to define the font, size, and color of the title text.

Behavior Attributes

partialTriggers

String

Yes

The IDs of the components that should trigger a partial update. This component listens on the trigger components. If a trigger component receives an event that causes it to update in some way, this component requests 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 - "::" pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" pop out of two naming containers (including itself if the component is a naming container) and begin the search from there.

disclosureListener

javax.el.MethodExpression

Yes

A method reference to a disclosure listener.

A disclosure event is fired when the user expands or collapses the Show Detail Frame component.

stretchContent

String

Yes

Specifies whether the Show Detail Frame stretches its child component.

Available options are true, false, and auto. The default value is true.

You can use the stretchContent attribute to stretch a child component that supports being stretched. For example, container components like Panel Form Layout, Panel Customizable, and Show Detail Item provide the capability to be stretched.

If you select true, then the child component is stretched to the height and width of the Show Detail Frame's content area.

The default height of the Show Detail Frame is 200px. The height of the Show Detail Frame is defined using the ContentStyle attribute.

If you select auto, the child component is stretched only if the Show Detail Frame is wrapped inside a component that stretches it. If not, stretchContent is set to false.

Advanced Attributes

binding

oracle.adf.view.page.editor.component.ShowDetailFrame

Supports only EL

An EL reference that stores the component instance in 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

javax.el.MethodExpression

Yes

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 event might include the width of a column that supported client-side resizing.

selectChild

String

Yes

Specifies whether runtime selection and customization are enabled on child components. This is relevant only in a Composer-enabled page, that is, if the Show Detail Frame component is nested within a Page Customizable component.

Default value is yes. However, when you add a task flow as a child of the Show Detail Frame component, this attribute defaults to no.

If you select yes, then child components can be selected and customized at runtime.

Customization Attributes

customizationAllowed

Boolean

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

customizationAllowedBy

String

Specifies the roles for which customization is enabled.

Other Attributes

childCreation

String

Yes

Specifies when the children (contents) of the Show Detail Frame component are created. Valid values are:

• immediate (default): All children are immediately created when the Show Detail Frame component is rendered, even when it is collapsed.

• lazy: Children are created when the Show Detail Frame component is likely to be expanded. This behavior optimizes performance by postponing the creation of children until the Show Detail Frame parent component is expanded. The children remain in cached memory for subsequent display.

• lazyUncached: Children are created when the Show Detail Frame parent component is likely to be expanded, and children are deleted when no longer visible. This means children do not reside in cached memory when not visible so must be re-created each time the parent component is expanded.

customizationId

This attribute has been deprecated. Use the id attribute.

helpTopicID

String

Yes

Specifies a Help topic ID that is used to link to a custom Help topic from the component.

To link to a Help topic from your Show Detail Frame component instance, you can either link to an HTML file that is stored directly in your application directory, or to a Help topic that is part of a JAR file.

Common Attributes

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

action

String

Yes

Specifies the action outcome defined for the task flow. The value of this attribute must match the relevant ADFc outcome in the task flow definition file.

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

The rendering of a component can also be defined at runtime using the Show Component and Hide Component options.

text

String

Yes

Represents the text of the menu item link.

This is applicable for a custom action rendered as a menu item link.

Appearance Attributes

icon

String

Yes

For a custom action rendered as a toolbar link, specifies the icon to be rendered on the chrome. For a custom action rendered as a menu item link, this represents the icon to be displayed against the menu item text. This attribute supports these various types of URIs:

• absolute - an absolute path to the image, like "http://oracleimg.com/admin/images/ocom/hp/oralogo_small.gif"

• relative - a path located relatively to the source page, like "bullet.jpg"

• context relative - a path relatively based on the web application's context root, like "/images/error.png"

• server relative - a path relatively based on the web server by application name, like "//adf-richclient-demo-context-root/images/error.png"

As icon does not allow alternative text to be provided for the image, in order to create an accessible product an icon must only be used when its use is purely decorative.

shortDesc

String

Yes

Provides a 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, for example, Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

This is applicable only for a custom action rendered as a toolbar icon.

location

String

Yes

Determines whether the custom action is rendered as a toolbar icon or a menu item link.

Available values are chrome, menu, or both. Default value is chrome.

Customization Attributes

customizationAllowed

Boolean

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

customizationAllowedBy

String

Specifies the roles for which customization is enabled.

Other Attributes

actionComponent

String

Yes

Specifies the ID of the command component that must be queued for the action event. When the actionComponent attribute is specified, the Show Detail Frame component queues the action event on this component.

For more information, see Section 20.3.2.3, "Configuring Custom Actions that Display Task Flow Views in a Separate Browser Window."

customizationId

This attribute has been deprecated. Use the id attribute.

Common Attributes:

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

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

The rendering of a component can also be defined at runtime using the Show Component and Hide Component options.

attributeType

String

Yes

Specifies the property type. Supported values are text, cbox, date, lov.

value

String

Yes

Specifies the current value of the property. If the EL binding for the "value" points to a bean property with a getter but no setter, and this is an editable component, the component will be rendered in read-only mode.

label

String

Yes

Specifies the label of the component. If you want the label to appear above the control, use a panelFormLayout.

Data Attributes:

value

String

Yes

Specifies the current value of the property. If the EL binding for the "value" points to a bean property with a getter but no setter, and this is an editable component, the component will be rendered in read-only mode.

selectItem

Specifies the list of values to be displayed if attributeType was set to lov. This attribute takes an EL value that returns the list of values dynamically.

Appearance Attributes:

columns

Int

Yes

Specifies the size of the text control specified by the number of characters shown. The number of columns is estimated based on the default font size of the browser.

rows

Int

Yes

Specifies the height of the text control specified by the number of characters shown. The default value is 1, which generates a one-row input field. The number of rows is estimated based on the default font size of the browser.

label

String

Yes

Specifies the label of the component. If you want the label to appear above the control, use a panelFormLayout.

shortDesc

String

Yes

Provides a 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, for example, Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

This is applicable only for a custom action rendered as a toolbar icon.

simple

Boolean

Yes

A boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.

unselectedLabel

String

Yes

Specifies the label for the option that represents a value of null, meaning nothing is selected. If unselectedLabel is not set and if the component does not have a selected value, then an option with an empty string as the label and value is rendered as the first option in the choice box (if there isn't an empty option already defined). Once an option has been successfully selected, and if unselectedLabel is not set, then the empty option will not be rendered.

Behavior Attributes:

required

Boolean

Yes

Specifies whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.

autoSubmit

Boolean

Yes

Specifies an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.

disabled

Boolean

Yes

Specifies whether the property should be shown as disabled. This is useful if the Show Property component is inside an iterator whose model specifies that the property must be shown as disabled, for example, if an MDS restriction has been applied on the property.

validator

String

Yes

Specifies a method reference to a validator method.

valueChangeListener

javax.faces.el.MethodBinding

EL only

Specifies a method reference to a value change listener.

Advanced Attributes:

binding

oracle.adf.view.rich.component.fragment.UIXDeclarativeComponent

Supports only EL

Specifies an EL reference that stores the component instance in 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

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

componentId

If you use the Show Property tag in Composer's property panel, componentId specifies the ID of the component for which the property must be rendered.

showELBuilder

Boolean

Yes

Specifies whether to display the EL builder for the property.

showResourceEditor

Boolean

Yes

Specifies whether to display the resource string editor for the property. However, this option is enabled only if you have configured resource string editing in the application and the property is of type String. For more information, see Section 20.12, "Configuring Runtime Resource String Editing."

taskFlowId

String

Yes

If Show Property is used to display task flow parameters, taskFlowId specifies the ID of the task flow.

taskFlowParam

String

Yes

If Show Property is used to display task flow parameters, taskflowParam specifies the task flow parameter that the input field must display.

customizationId

This attribute has been deprecated. Use the id attribute.

Customization Attributes

customizationAllowed

Boolean

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

customizationAllowedBy

String

Specifies the roles for which customization is enabled.

Other Attribute

text

String

Yes

Specifies the text used for the check box. This is used only when type is set to boolean.

background-color

The background color of the component. Choose from a list of colors, or click the Edit icon to select from a color palette.

background-image

The image that is displayed in the component background. Select to inherit from a parent component or to display no image, or click the Edit icon to select an image.

background-repeat

Specify whether and how the background image should repeat. Choose from:

• <none>: Forgo repeating the image.

• no-repeat: Forgo repeating the image.

• repeat: Repeat the image to fill the container.

• repeat-x: Repeat the image horizontally but not vertically.

• repeat-y: Repeat the image vertically but not horizontally.

• inherit: Inherit this setting from a parent component.

border-color

The color of the border that surrounds the component. Choose from a list of colors, or click the Edit icon to select from a color palette.

border-style

The style of border to draw around the component. Choose from:

• <none>: Apply no style to the border.

• none: Do not display a border (use border-style:none on the ContentStyle property to turn off portlet borders. Using this attribute with InlineStyle does not turn off portlet borders.)

• hidden: Hide the border.

• dotted: Display the border as a line of dots.

• double: Display the border as a double line.

• groove: Display the border as a grooved line.

• ridge: Display the border as a ridged line.

• inset: Display the border as a concave line.

• outset: Display the border as a convex line.

• dashed: Display the border as a line of dashes.

• solid: Display the border as a solid line.

• inherit: Inherit the border style from a parent component.

border-width

The thickness of the component border. Select thick, medium, thin, or inherit to determine the thickness of the border or inherit border width from a parent component. Alternatively, click the Edit icon and define a thickness in your preferred unit of measurement.

color

The color of the component text. Select from a list, or click the Edit icon to select from a color palette.

font-family

The font family (such as Arial, Helvetica, or sans-serif) for the component text. Enter this value manually.

font-size

The size of component text. Choose from:

• Choose Length: Specify an absolute value for the font-size in your preferred unit of measurement.

• Choose Percentage: Specify font size as a percentage of the normal text size defined for the browser.

• inherit: Inherit font size from a parent component.

• large: Select the next size larger than the font associated with the parent component.

• larger: Increase the font size to larger than the font associated with the parent component (larger is larger than large).

• medium: Set the font size to the default font size of the parent component.

• small: Set the font size to smaller than the default font size of the parent component.

• smaller: Set the font size to smaller than the default font size of the parent component (smaller is smaller than small).

font-style

The font style of the component text. Choose from:

• <none>: Apply no style to the font.

• normal: The font is not italic.

• italic: The font is italic.

• oblique: The font is slanted to look italic, though the font family may not have a formal italic member.

• inherit: Inherit font style from a parent component.

font-weight

The thickness of the component text. Choose from:

• <none>: Specify no weight for the component text.

• normal: Apply same weight as the parent component's default font weight.

• bold: Set component text in bold.

• bolder: Set component text darker than bold.

• light: Set component text lighter than normal.

• lighter: Set component text lighter than light.

• 100–900: Specify a value for text darkness—100 is lightest and 900 is darkest—400 is normal weight; 700 is bold.

• inherit: Inherit font weight from a parent component.

height

The spacing to apply between lines of continuous text (also known as leading). Specify a height by choosing from:

• Choose Length: Specify an absolute value in your preferred unit of measurement.

• Choose Percentage: Specify a value as a percentage of the value set for a parent component.

• auto: Set line height automatically, usually about 2 points larger than font size.

• inherit: Inherit line height from the parent component.

list-style-image

An image to use as an indicator of a list item. Specify an image instead of defining a list-style-type. Choose from:

• inherit: Inherit a list style image from a parent component.

• none: Use no image as an indicator of a list item.

Or click the Edit icon and select an image.

list-style-type

The type of indicator to use for items on a list. Use this instead of specifying a image through list-style-image.

Select from among many styles offered on the list, including <none>, which means the browser's default style is used, and inherit, which means the list-style-type is inherited from a parent component.

margin

The border of space surrounding the component content. Choose from:

• Choose Length: Specify an absolute value for all margins.

• Choose Percentage: Set a value as a percentage of the margin of a parent component.

• inherit: Inherit margin value from a parent component.

• auto: Set the value automatically according to browser defaults.

padding

The amount of space between the component and its margin or, if there is a border, between the component and its border. Choose from:

• Choose Length: Specify an absolute value in your preferred unit of measurement.

• Choose Percentage: Specify the value as a percentage of the padding set for a parent component.

• inherit: Inherit the value from a parent component.

text-align

The horizontal alignment of the component text. Choose from:

• <none>: Use browser default.

• left

• right

• center

• justify: Align text so that all lines start and end at the same point left and right.

• auto: Apply a value automatically, either left or right.

• inherit: Inherit alignment from a parent component.

text-decoration

The decorative value to apply to component text. Choose from:

• <none>: Use the browser default for hyperlinks; otherwise, no text decoration.

• none: No text decoration, including no underscore for hyperlinks.

• underline: Draw a line under all component text.

• overline: Draw a line over all component text.

• line-through: Draw a line through the middle of all component text.

• blink: Make component text blink.

• inherit: Inherit text decoration from a parent component.

vertical-align

The vertical alignment of component text. Choose from:

• Choose Length: Specify an absolute value in your preferred unit of measurement.

• Choose Percentage: Specify a value as a percentage of the value set for a parent component.

• inherit: Inherit the value from a parent component.

• baseline: Set the text on the baseline of the text row.

• middle: Set the text in the middle of the text row.

• text-bottom: Set the text on the bottom of the text row, lower than the baseline.

• text-top: Set the text at the top of the text row, above the baseline.

• sub: Set the text as subscript.

• super: Set the text as superscript.

width

The spacing between text. Specify a width by choosing from:

• Choose Length: Specify an absolute value in your preferred unit of measurement.

• Choose Percentage: Specify a value as a percentage of the value set for a parent component.

• auto: Set line height automatically, usually about 2 points larger than font size.

• inherit: Inherit line height from the parent component.

Common Attributes

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

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

layout

List of values

horizontal/vertical

Yes

Specifies how the children of the Panel Customizable (HTML) are laid out.

The default value is vertical.

Depending on the value of the layout attribute, child components are laid out as follows:

If you select vertical, then the child components are displayed one below the other and can be moved either up or down within the layout.

If you select horizontal, then the child components are displayed adjacent to each other and can be moved either to the left or right within the layout.

Style Attributes

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.

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 must create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Advanced Attributes

binding

String

Yes

An EL reference that stores the component instance in 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.

For example:

binding="#{yourManagedBean.Binding}"

Customization Attributes

customizationAllowed

Boolean

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

customizationAllowedBy

String

Specifies the roles for which customization is enabled.

Other Attribute

customizationId

This attribute has been deprecated. Use the id attribute.

Common Attributes

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

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

text

String

Yes

A title for the Show Detail Frame (HTML) component.

icon

String

Yes

If you want to add an icon on the header of the Show Detail Frame component, then this specifies the URI for the image to be used.

For example:

icon="http://source-pc/images/accessability.gif"

Note: An image that is stored at the document root does not require a full path. For example:

icon="detail.gif"

Appearance Attributes

text

String

Yes

A title for the Show Detail Frame (HTML) 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, for example, Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

icon

String

Yes

If you want to add an icon on the header of the Show Detail Frame component, then this specifies the URI for the image to be used.

For example:

icon="http://source-pc/images/accessability.gif"

Note: An image that is stored at the document root does not require a full path. For example:

icon="detail.gif"

background

List of values

light/medium/dark

Yes

Working with the skin CSS, provides a means of applying a different look and feel for this Show Detail Frame (HTML) instance.

The default value is medium.

displayHeader

Boolean

Yes

Indicates whether the header of the Show Detail Frame (HTML) is displayed.

The default value is true.

If you set displayHeader to false and if you have exposed some actions on the component, then a toolbar is displayed when you move the mouse over the component area. The toolbar contains a drop down icon, which displays a menu of available options. This toolbar is rendered only if there are actions available on the component.

The toolbar display is also affected by the isSeededInteractionAvailable attribute. As the default value for isSeededInteractionAvailable is false, the toolbar is not displayed. It can be displayed by setting isSeededInteractionAvailable to true.

expansionMode

List of values

maximized/minimized/normal

Yes

The default state of the Show Detail Frame (HTML).

The default display mode is normal.

rendered

Boolean

Yes

Specifies whether the component is rendered. When set to false, no output is delivered for this component (the component is not in any way rendered, and cannot be made visible on the client).

The default value is true.

Actions Attributes

showMoveAction

List of values

menu/none

Yes

Specifies whether the Move action is displayed in the Actions menu.

The default value is menu.

showMinimizeAction

List of values

chrome/none

Yes

Specifies whether the minimize action is displayed on the header.

The default is chrome.

showMaximizeAction

List of values

menu/none

Yes

Specifies whether the minimize action is displayed on the header.

The default value is menu.

Style Attributes

contentStyle

String

Yes

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

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.

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 must create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Behavior Attributes

partialTriggers

String

Yes

The IDs of the components that should trigger a partial update. This component listens on the trigger components. If a trigger component receives an event that causes it to update in some way, this component requests 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 - "::" pops out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" pops out of two naming containers (including itself if the component is a naming container) and begin the search from there.

disclosureListener

javax.el.MethodExpression

Yes

A method reference to a disclosure listener.

A disclosure event is fired when the disclosure state changes.

Advanced Attributes

binding

String

Yes

An EL reference that stores the component instance in 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.

For example:

binding="#{yourManagedBean.Binding}"

attributeChangeListener

javax.el.MethodExpression

Yes

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.

Customization Attributes

customizationAllowed

Boolean

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

customizationAllowedBy

String

Specifies the roles for which customization is enabled.

Other Attribute

customizationId

This attribute has been deprecated. Use the id attribute.