Oracle Fusion Middleware Tag Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81455-03

# <af:commandImageLink>

af:commandImageLink commandImageLink command image link

UIComponent class: oracle.adf.view.rich.component.rich.nav.RichCommandImageLink
Component type: oracle.adf.RichCommandImageLink

Unsupported agents: pda

The commandImageLink component creates a link that has icon support, when pressed, will generate an action event on the server. This component will be included when the page is being displayed in emailable and printable modes.

## Geometry Management

- This component cannot be stretched by a parent layout component.
- This component does not have support for stretching its children.

## Screen Shot(s)

A commandImageLink component with icon and text attributes set.

## Code Example(s)

    <af:commandImageLink text="Search"
                         icon="/images/search.gif"
    		     actionListener="#{some.el.expression}"/>
    <af:commandImageLink text="Folders"
                         icon="/images/folders.gif"
                         hoverIcon="/images/folders_h.gif"
                         depressedIcon="/images/folders_m.gif"/>

## Events

Type | Phases | Description
--- | --- | ---
javax.faces.event.ActionEvent | Invoke, Application, Apply, Request, Values | Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation.
org.apache.myfaces.trinidad.event.ReturnEvent | Apply, Request, Values | Event delivered when the dialog has completed successfully.
org.apache.myfaces.trinidad.event.LaunchEvent | Invoke, Application, Apply, Request, Values | Event delivered to prompt the command to launch a dialog.
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
accessKey | char | Yes | a character used to gain quick access to this link. If the same access key appears in multiple input fields in the same page of output, the rendering user agent will cycle 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 Link instance. If it does not, the user will receive no visual indication of the existence of the accessKey. Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.
action | javax.el.MethodExpression | Yes | a reference to an action method sent by the command component, or the static outcome of an action. If the action starts with "dialog:", useWindow attribute must be set to true.
actionListener | javax.faces.el.MethodBinding | Only EL | a method reference to an action listener
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.nav.RichCommandImageLink | 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.
blocking | boolean | Yes | Default Value: false an attribute which if set to TRUE the component will start blocking user input when the action is initiated. The blocking will stop when a response is received from the server. Not supported on the following renderkits: oracle.adf.rich
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. For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml.
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.
depressedIcon | String | Yes | the URI of an image to be displayed with this link when the mouse has pressed the link. This attribute supports the same URI types described for the icon attribute.
disabled | boolean | Yes | Default Value: false whether the link should be considered disabled. This attribute only has meaning when links are used in certain container types, such as global headers and tab bars.
disabledIcon | String | Yes | the URI of an image to be displayed with this link when the link is disabled. This attribute supports the same URI types described for the icon attribute.
hoverIcon | String | Yes | the URI of an image to be displayed with this link when the mouse is hovering over the link. This attribute supports the same URI types described for the icon attribute. This image is not rendered in touch screen devices.
icon | String | Yes | the URI of an image to be displayed with the link. SVG icons are also supported, please refer to "iconDelivery" attribute for various SVG embed modes. 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"
iconDelivery | String | Yes | Valid Values: auto, reference, inline, fetchAndInline Default Value: auto An attribute specifying ways to render icon. reference - icon will be rendered as "img" tag. inline - svg icon will be rendered inline as "svg" tag fetchAndInline - svg icon will be fetched using XHR and will be rendered inline as "svg" tag. For subsequent requests, svg will be served from browser cache auto - Lets the framework decide the optimal rendering mode. You can use the skinnng property -tr-icon-delivery to override default framework behavior. Skinning property -tr-icon-delivery can be set to any one of "inline/reference/fetchAndInline" modes. However "inline" and "fetchAndInline" modes apply only for svg icons. Details about attribute values "inline" and "fetchAndInline" :- Only svg icons will be inlined. Only context relative and server relative icon URIs are supported Hover, disabled and depressed states should be handled through CSS classes/styles on svg elements. The hoverIcon, disabledIcon and depressedIcon attributes will be ignored.
iconPosition | String | Yes | Valid Values: leading, trailing Default Value: leading an attribute specifying the position of the icon.
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 data validation - client-side or server-side - will 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, will be executed during 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 will skip validation.
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.
launchListener | javax.el.MethodExpression | Only EL | a method reference to a launch listener
partialSubmit | boolean | Yes | Default Value: false whether the action should be done through a partial page submit or not. Default is false: no partial page submit; the full page will be refreshed. When set to true, the full page will not be refreshed. To re-render specific components on your page in response to the partial page submit, you have to tell ADF Faces. The easiest way to do this is with the partialTriggers attribute.
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.
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.
returnListener | javax.el.MethodExpression | Only EL | a method reference to a return listener.This method is used to process dialog returnEvents which are generated as a result of either calling org.apache.myfaces.trinidad.context.RequestContext.returnFromDialog directly or declaratively through the use of a returnActionListener tag.
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.
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'.
text | String | Yes | the textual label of the link.
textAndAccessKey | String | Yes | an attribute that will simultaneously set both the "text" and "accessKey" attributes from a single value, using conventional ampersand ('&') notation. For example, setting this attribute to "T&amp;ext" will set the text to "Text" and the access key to 'e'.
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.
useWindow | boolean | Yes | Default Value: false whether processes launched by this command should be launched in a secondary browser dialog window. 'useWindow' requires that the "action" attribute start with "dialog:". Set useWindow to 'false' for the outcome of the action to be targeted to the existing window.
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
windowEmbedStyle | String | Yes | Valid Values: window, inlineDocument Default Value: window Controls the embedded style of launched window. The "window" option will indicate a new browser window. The "inlineDocument" option will indicate an inline popup window. The default value is "window".
windowHeight | int | Yes | the height of the window, if this command is used to launch a window.
windowModalityType | String | Yes | Valid Values: applicationModal, modeless Default Value: modeless Controls the modality of the launched Dialog. The default is modeless.
windowWidth | int | Yes | the width of the window, if this command is used to launch a window.