Project Documentation

Summary

Tag name: <tr:panelPopup>
UIComponent 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.AttributeChangeEventInvoke 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
triggerContent 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
attributeChangeListenerjavax.el.MethodExpressionOnly 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.
bindingorg.apache.myfaces.trinidad.component.core.layout.CorePanelPopupOnly 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.
contentStyleStringYes The inline style of the content region.
heightintYes Default Value: 0

Set the height of the popup. If not present the width defaults to the height of the content.
iconStringYes 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.
idStringNo 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 ('-').
inlineStyleStringYes the CSS styles to use for this component.
modalbooleanYes 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.
onclickStringYes an onclick Javascript handler.
ondblclickStringYes an ondblclick Javascript handler.
onkeydownStringYes an onkeydown Javascript handler.
onkeypressStringYes an onkeypress Javascript handler.
onkeyupStringYes an onkeyup Javascript handler.
onmousedownStringYes an onmousedown Javascript handler.
onmousemoveStringYes an onmousemove Javascript handler.
onmouseoutStringYes an onmouseout Javascript handler.
onmouseoverStringYes an onmouseover Javascript handler.
onmouseupStringYes an onmouseup Javascript handler.
partialTriggersString[]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".

positionStringYes 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).
renderedbooleanYes 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.
shortDescStringYes The short description of the component. This text is commonly used by user agents to display tooltip help text.
styleClassStringYes a CSS style class to use for this component.
textStringYes The text to render as a link to launch the popup panel. If the 'trigger' facet is defined, then this attribute is ignored.
titleStringYes The title of the panel when visible. The titlebar is not rendered if this attribute is not specified.
triggerTypeStringYes 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.
widthintYes Default Value: 0

Set the width of the popup. If not present the width defaults to the width of the content.
xoffsetintYes Default Value: 0

The popup's horizontal offset in pixels from the current mouse position. This property only applies to popups using relative positioning.
yoffsetintYes Default Value: 0

The popup's vertical offset in pixels from the current mouse position. This property only applies to popups using relative positioning.