Composer Library - Custom Action Component

Use the Custom Action Component to trigger the desired navigational flow in a task flow that is wrapped in a Show Detail Frame component on the page. More

Custom actions can be included either as icons on the chrome of a Show Detail Frame or as menu items on its Action menu. When clicked, these controls trigger the desired navigational flow for the task flow. You can specify custom actions on Show Detail Frame components in the following ways:

Use the Custom Action tag to specify custom actions on a particular instance of the Show Detail Frame component.

Example

<cust:showDetailFrame text="showDetailFrame 1"
                      id="sdf1">
      <af:region value="#{bindings.taskflowdefinition1.regionModel}
                 id="r1"/>
      <cust:customAction action="aheadTF" id="ca1" 
                                                  text="Go To View 2"/>
      <cust:customAction action="backTF" id="ca2" 
                                                  text="Go To View 1" 
                         shortDesc="Go To View 2 Global"/>
</cust:showDetailFrame>

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

action

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

rendered

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

Represents the text of the menu item link. This is applicable for a custom action rendered as a menu item link.

Appearance Attributes

Element Description

icon

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

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 truncates long tooltips. For form components, the shortDesc is displayed in a note window.This is applicable for a custom action rendered as a toolbar icon.

location

Determines whether the custom action is rendered as a toolbar icon or a menu item link. Available values are chrome, menu, and both. The default value is menu.

Other Attributes

Element Description

actionComponent

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.

The Expression Builder option available when setting these attributes allows you to bind the Custom Action instance to a managed bean property.

customizationId

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

Related Topics

"Adding Custom Actions to Components" in Developing WebCenter Portal Assets and Custom Components with Oracle JDeveloper