Apache MyFaces Trinidad – <tr:panelPopup>

Parent Project

Apache MyFaces Trinidad

Project Documentation

Summary

Tag Name:	<tr:panelPopup>
Java Class:	org.apache.myfaces.trinidad.component.core.layout.CorePanelPopup
Component Type:	org.apache.myfaces.trinidad.CorePanelPopup

The panelPopup is used to place ancillary information on a page, made visible via a clickable link (e.g icon or link).

The text attribute or 'trigger' facet is used to define the clickable area of the page. When clicked a floating panel is made visible containing the child components. If the title attribute is present, then a title bar (including the title) will be rendered for the popup panel.

The position attribute of popupPanel can be used to control the location of the panel when visible.

You can make changes to the style of the content region of this component by adding your custom styles to the contentStyle attribute.

Content containers will generally have only one child with the actual contents as its children. This child will describe how the content should be displayed. However, the content container can have multiple children, in which case the children are displayed in a stack fashion, lined up vertically.

Code Example(s)

<tr:panelPopup text="Click Here!">
  <tr:panelGroupLayout layout="vertical">
    <tr:goLink text="point 1" destination="http://myfaces.apache.org"/>
    <tr:goLink text="point 2" destination="http://myfaces.apache.org"/>
    <tr:goLink text="point 3" destination="http://myfaces.apache.org"/>
  </tr:panelGroupLayout>
</tr:panelPopup>

Supported Client Events for Client Behaviors

click (default)
dblclick
keydown
keypress

keyup
mousedown
mousemove
mouseout

mouseover
mouseup

Events

Type	Phases	Description
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.

Supported Facets

Name	Description
trigger	Content to be rendered as a link to launch the popup panel. Use this facet to define an icon or other content types to launch the popup. If this facet is not defined, then the 'text' attribute must be specified.

Attributes

Name	Type	Supports EL?	Description
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	org.apache.myfaces.trinidad.component.core.layout.CorePanelPopup	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.
contentStyle	String	Yes	The inline style of the content region.
height	int	Yes	Default Value: 0 Set the height of the popup. If not present the width defaults to the height of the content.
icon	String	Yes	The icon to render as a link to launch the popup panel. If the 'trigger' facet is defined, then this attribute is ignored. If the 'text' attribute is also specified, then the icon and text will both be rendered.
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).
inlineStyle	String	Yes	the CSS styles to use for this component.
modal	boolean	Yes	Default Value: false The display mode of the panel. Defaults to "false" (non-modal). Non-Modal panels will close when the user clicks off the panel. Modal popups are rendered with a titlebar and close icon. Clicking the close icon will close the modal popup.
onclick	String	Yes	an onclick Javascript handler.
ondblclick	String	Yes	an ondblclick Javascript handler.
onkeydown	String	Yes	an onkeydown Javascript handler.
onkeypress	String	Yes	an onkeypress Javascript handler.
onkeyup	String	Yes	an onkeyup Javascript handler.
onmousedown	String	Yes	an onmousedown Javascript handler.
onmousemove	String	Yes	an onmousemove Javascript handler.
onmouseout	String	Yes	an onmouseout Javascript handler.
onmouseover	String	Yes	an onmouseover Javascript handler.
onmouseup	String	Yes	an onmouseup Javascript handler.
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. Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2" Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
position	String	Yes	Valid Values: relative, centered Default Value: relative The position of the content container when visible. Defaults to "relative" if not specified. Other values are "centered" (centered on screen).
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.
shortDesc	String	Yes	The short description of the component. This text is commonly used by user agents to display tooltip help text.
styleClass	String	Yes	a CSS style class to use for this component.
text	String	Yes	The text to render as a link to launch the popup panel. If the 'trigger' facet is defined, then this attribute is ignored.
title	String	Yes	The title of the panel when visible. The titlebar is not rendered if this attribute is not specified.
triggerType	String	Yes	Valid Values: click, hover Default Value: click Defines the launch behaviour of the popup. If set to 'click' the popup will appear when the trigger is clicked, and disappear when you click off the popup. The 'hover' value will cause the popup to appear while the mouse is over the trigger, and disappear when the mouse leaves either the trigger or the popup panel.
width	int	Yes	Default Value: 0 Set the width of the popup. If not present the width defaults to the width of the content.
xoffset	int	Yes	Default Value: 0 The popup's horizontal offset in pixels from the current mouse position. This property only applies to popups using relative positioning.
yoffset	int	Yes	Default Value: 0 The popup's vertical offset in pixels from the current mouse position. This property only applies to popups using relative positioning.