af:showPopupBehavior tag is a declarative way to show a
af:popup in response to a client-side event. The client event is specified using the
triggerType attribute. The "action" event is the default
triggerType if one is not provided. When the
showPopupBehavior tag is associated with a component, the popup specified via the
popupId attribute will automatically be shown when the associated client event is activated. This tag only acts on client events similar to the
align attributes are used to specify the location a popup should be opened. These attributes are required for most types of popups (See
af:popup for popup types). However, there are a few exceptions to this rule. The
af:panelWindow popup types do not require alignment attributes. These types of popups can be manually repositioned using drag-and-drop and will open by default at the center of the browser window. The third exception that doesn't require alignment attributes is for popup's using the "contextMenu"
triggerType. The "contextMenu" event is fired on a right mouse click. For this trigger type, popup alignment is by mouse position.
showPopupBehavior tag cancels the client event defined by the
triggerType. Canceling the client event will prevent delivery to the server. This is significant for action events raised by command family components because the server-side action listeners will be ignored. All
actionListener method bindings and associated action listeners will not be invoked when the
triggerType of "action" is used.
showPopupBehavior tag is only a subscriber of component events meaning that it can only react to client component events. The various client events and sequences in which client events are raised are component specific, unknown to the
af:clientListener that uses
af:serverListener to deliver a server-side event.
There are special behaviors added to the
showPopupBehavior tag based on look-and-feel standards. An inline selector type of popup will toggle visibility of the associated popup. If the inline selector is already shown, the popup will be dismissed. This behavior only applies to inline selector types of popups.
A single popup can be opened by several launching sources using the
showPopupBehavior tag. If a popup is already visible and a request to open using a
showPopupBehavior tag from another launching source is made, the shared popup will be dismissed before showing again. If the popup is already visible and another request to show it is made from the same launching source the request is ignored (excluding the inline selector).
The "mouseOver" or "mouseHover" event types have a built in 500-millisecond launch delay that is implicitly canceled if a "mouseOut" event is triggered for the same component within the delay period.
All popup types have determined auto-dismissal behaviors. See the
af:popup tag documentation for a breakdown of popup types and assumed behaviors.
This example will show the popup with the id "somePopup" when the button is clicked.
<af:commandButton id="button" text="Click me"> <af:showPopupBehavior popupid="somePopup" alignid="button" align="endBefore" triggerType="action" /> </af:commandButton>
This example will shows a menu popup with the id "someMenuPopup" when anything within the panelGroupLayout is right-clicked.
<af:panelGroupLayout> <af:showPopupBehavior popupid="someMenuPopup" triggerType="contextMenu"/> .... any other content ... </af:panelGroupLayout>
Trigger types of mouseHover, mouseMove, mouseOver, and mouseOut are suppressed in screen reader mode. This is to prevent unwanted and unexpected visits away from the host page to a popup screen. If you use one of these triggerTypes, make sure you provide alternate access to the same content in screen reader mode.
Do not create popups that are only available by mouse! If you are using one of the mouse triggerTypes, make sure that your popup is also accessible via the keyboard. This is true for both rich and screen reader mode.
The following table lists component family-specific event types that can be assigned to the triggerType attribute:
|Event Type||Component Family||Description|
|action||Command||Fires when user triggers the command component. Owning component's server-side action listeners will be ignored since the event will be canceled.|
|contextInfo||ContextInfo||Fires when user clicks the icon in a contextInfo|
|dialog||Dialog||Fires when user clicks dialog OK/Cancel buttons|
|disclosure||ShowDetail||Fires when disclosure state is toggled|
|inlineFrameLoad||InlineFrame||Queued when the internal iframe fires its load event|
|load||Document||Fires when the document finishes loading|
|fetch||Popup||Content fetch event fired before opening if the content delivery of the popup is lazy or lazyUncached. This is the first of two events required for content delivery.|
|contentLoaded||Popup||Partial content delivery has been delivered to the browser. This event notifies the popup component that it can be shown. Second content delivery event.|
|popupOpening||Popup||Fired prior to opening a popup|
|popupOpened||Popup||Fired after popup is opened|
|popupClosed||Popup||Fired after popup is closed|
|query||Query||Fired when a query action happens(when user clicks the search icon in quickQuery or the search button in the query component)|
|rowDisclosure||Tree, TreeTable||Fired row disclosure state is toggled|
|selection||Table, Tree, TreeTable||Fires when selection state changes|
|sort||Table||Fires when user sorts data|
|valueChange||Input, Select\*||Fires when the value of an input control is changed|
The following table lists input (mouse/keyboard) event types. These events are delivered for all components (though in some cases may be consumed by the peer implementation) and can be assigned to the triggerType attribute:
|click||Fires when user clicks on component. When the event source is a command family component, the component will still raise the action event.|
|contextMenu||Shows the popup on right mouse click. Assumes aligment is by mouse position.|
|dblClick||Fires when user double clicks on component|
|mouseDown||Fires when user performs mouse down on component|
|mouseUp||Fires when user performs mouse up on component|
|mouseMove||Fires when user moves mouse while over a component. Note that showPopupBehaviors with trigger type "mouseMove" are suppressed in screen reader mode.|
|mouseOver||Fires when mouse enters a component. Assumes a 500-millisecond delay before launching the popup. A "mouseOut" raised within the delay period, cancels a pending launch request. Note that showPopupBehaviors with trigger type "mouseOver" are suppressed in screen reader mode.|
|mouseOut||Fires when mouse leaves a component. Note that showPopupBehaviors with trigger type "mouseOut" are suppressed in screen reader mode.|
|keyDown||Fires when user presses key down while focused on a component|
|keyUp||Fires when user releases key while focused focused on a component|
|keyPress||Fires when successful key press occurs while focused on a component|
|focus||Fires when component gains keyboard focus|
|blur||Fires when component loses keyboard focus|
The following table lists hybrid event types that combine multiple event types:
|mouseHover||Hybrid event type that shows the popup on "mouseOver" and hides the popup on "mouseOut". This event assumes a 500ms delay before launching the popup. A "mouseOut" event fired within the 500ms delay, cancels a pending launch request. This event type requires alignment to an element by using the
|popupId||String||yes||the ID of the popup, relative to the containing component. An ID beginning with a colon will be treated as absolute (after trimming off the colon).|
|alignId||String||no||the ID of the component relative to which the popup will be aligned. An ID beginning with a colon will be treated as absolute (after trimming off the colon). All other ids will be resolved relative to the component which contains the showPopupBehavior.|
indicates how the popup should aligned relative to the alignId component. Valid values include:
|triggerType||String||no||the event type which will trigger the popup being shown. By default, this is "action". To show a popup menu, use "contextMenu". To show a non-modal popup upon the mouse appearing over the trigger component and also to hide it upon the mouse leaving the trigger component, use "mouseHover". Note that showPopupBehaviors with trigger type "mouseHover", "mouseMove", "mouseOver", and "mouseOut" are suppressed in screen reader mode. See "Client Event Trigger Types" section above for a complete list of trigger types.|