org.apache.myfaces.trinidad.component.core.layout
Class CorePanelPopup

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXPanel
                  extended by org.apache.myfaces.trinidad.component.core.layout.CorePanelPopup
All Implemented Interfaces:
javax.faces.component.StateHolder

public class CorePanelPopup
extends UIXPanel

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 alignment 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.

Events:

Type Phases Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent 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 events might include the width of a column that supported client-side resizing.


Field Summary
static java.lang.String ALIGNMENT_CENTER
           
static PropertyKey ALIGNMENT_KEY
           
static java.lang.String ALIGNMENT_NONE
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static PropertyKey CONTENT_STYLE_KEY
           
static PropertyKey HEIGHT_KEY
           
static PropertyKey ICON_KEY
           
static PropertyKey INLINE_STYLE_KEY
           
static PropertyKey MODAL_KEY
           
static PropertyKey ONCLICK_KEY
           
static PropertyKey ONDBLCLICK_KEY
           
static PropertyKey ONKEYDOWN_KEY
           
static PropertyKey ONKEYPRESS_KEY
           
static PropertyKey ONKEYUP_KEY
           
static PropertyKey ONMOUSEDOWN_KEY
           
static PropertyKey ONMOUSEMOVE_KEY
           
static PropertyKey ONMOUSEOUT_KEY
           
static PropertyKey ONMOUSEOVER_KEY
           
static PropertyKey ONMOUSEUP_KEY
           
static PropertyKey PARTIAL_TRIGGERS_KEY
           
static PropertyKey SHORT_DESC_KEY
           
static PropertyKey STYLE_CLASS_KEY
           
static PropertyKey TEXT_KEY
           
static PropertyKey TITLE_KEY
           
static java.lang.String TRIGGER_FACET
           
static PropertyKey TRIGGER_STYLE_KEY
           
static FacesBean.Type TYPE
           
static PropertyKey WIDTH_KEY
           
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
 
Constructor Summary
  CorePanelPopup()
          Construct an instance of the CorePanelPopup.
protected CorePanelPopup(java.lang.String rendererType)
          Construct an instance of the CorePanelPopup.
 
Method Summary
 java.lang.String getAlignment()
          Gets The position of the content container when visible.
protected  FacesBean.Type getBeanType()
           
 java.lang.String getContentStyle()
          Gets The inline style of the content region.
 java.lang.String getFamily()
           
 int getHeight()
          Gets Set the height of the popup.
 java.lang.String getIcon()
          Gets The text to render as a link to launch the popup panel.
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 java.lang.String getOnclick()
          Gets an onclick Javascript handler.
 java.lang.String getOndblclick()
          Gets an ondblclick Javascript handler.
 java.lang.String getOnkeydown()
          Gets an onkeydown Javascript handler.
 java.lang.String getOnkeypress()
          Gets an onkeypress Javascript handler.
 java.lang.String getOnkeyup()
          Gets an onkeyup Javascript handler.
 java.lang.String getOnmousedown()
          Gets an onmousedown Javascript handler.
 java.lang.String getOnmousemove()
          Gets an onmousemove Javascript handler.
 java.lang.String getOnmouseout()
          Gets an onmouseout Javascript handler.
 java.lang.String getOnmouseover()
          Gets an onmouseover Javascript handler.
 java.lang.String getOnmouseup()
          Gets an onmouseup Javascript handler.
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 java.lang.String getShortDesc()
          Gets The short description of the component.
 java.lang.String getStyleClass()
          Gets a CSS style class to use for this component.
 java.lang.String getText()
          Gets The text to render as a link to launch the popup panel.
 java.lang.String getTitle()
          Gets The title of the panel when visible.
 javax.faces.component.UIComponent getTrigger()
          Content to be rendered as a link to launch the popup panel.
 java.lang.String getTriggerStyle()
          Gets The inline style of the trigger.
 int getWidth()
          Gets Set the width of the popup.
 boolean isModal()
          Gets The display mode of the panel.
 void setAlignment(java.lang.String alignment)
          Sets The position of the content container when visible.
 void setContentStyle(java.lang.String contentStyle)
          Sets The inline style of the content region.
 void setHeight(int height)
          Sets Set the height of the popup.
 void setIcon(java.lang.String icon)
          Sets The text to render as a link to launch the popup panel.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setModal(boolean modal)
          Sets The display mode of the panel.
 void setOnclick(java.lang.String onclick)
          Sets an onclick Javascript handler.
 void setOndblclick(java.lang.String ondblclick)
          Sets an ondblclick Javascript handler.
 void setOnkeydown(java.lang.String onkeydown)
          Sets an onkeydown Javascript handler.
 void setOnkeypress(java.lang.String onkeypress)
          Sets an onkeypress Javascript handler.
 void setOnkeyup(java.lang.String onkeyup)
          Sets an onkeyup Javascript handler.
 void setOnmousedown(java.lang.String onmousedown)
          Sets an onmousedown Javascript handler.
 void setOnmousemove(java.lang.String onmousemove)
          Sets an onmousemove Javascript handler.
 void setOnmouseout(java.lang.String onmouseout)
          Sets an onmouseout Javascript handler.
 void setOnmouseover(java.lang.String onmouseover)
          Sets an onmouseover Javascript handler.
 void setOnmouseup(java.lang.String onmouseup)
          Sets an onmouseup Javascript handler.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setShortDesc(java.lang.String shortDesc)
          Sets The short description of the component.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setText(java.lang.String text)
          Sets The text to render as a link to launch the popup panel.
 void setTitle(java.lang.String title)
          Sets The title of the panel when visible.
 void setTrigger(javax.faces.component.UIComponent triggerFacet)
          Content to be rendered as a link to launch the popup panel.
 void setTriggerStyle(java.lang.String triggerStyle)
          Sets The inline style of the trigger.
 void setWidth(int width)
          Sets Set the width of the popup.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ALIGNMENT_NONE

public static final java.lang.String ALIGNMENT_NONE
See Also:
Constant Field Values

ALIGNMENT_CENTER

public static final java.lang.String ALIGNMENT_CENTER
See Also:
Constant Field Values

TYPE

public static final FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

ICON_KEY

public static final PropertyKey ICON_KEY

TEXT_KEY

public static final PropertyKey TEXT_KEY

TITLE_KEY

public static final PropertyKey TITLE_KEY

MODAL_KEY

public static final PropertyKey MODAL_KEY

ALIGNMENT_KEY

public static final PropertyKey ALIGNMENT_KEY

CONTENT_STYLE_KEY

public static final PropertyKey CONTENT_STYLE_KEY

TRIGGER_STYLE_KEY

public static final PropertyKey TRIGGER_STYLE_KEY

WIDTH_KEY

public static final PropertyKey WIDTH_KEY

HEIGHT_KEY

public static final PropertyKey HEIGHT_KEY

TRIGGER_FACET

public static final java.lang.String TRIGGER_FACET
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

CorePanelPopup

public CorePanelPopup()
Construct an instance of the CorePanelPopup.


CorePanelPopup

protected CorePanelPopup(java.lang.String rendererType)
Construct an instance of the CorePanelPopup.

Method Detail

getTrigger

public final javax.faces.component.UIComponent getTrigger()
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.


setTrigger

public final void setTrigger(javax.faces.component.UIComponent triggerFacet)
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.


getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component.


setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component.


getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component.


setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component.


getShortDesc

public final java.lang.String getShortDesc()
Gets The short description of the component. This text is commonly used by user agents to display tooltip help text.


setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets The short description of the component. This text is commonly used by user agents to display tooltip help text.


getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets 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, 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, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc.


setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets 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, 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, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc.


getOnclick

public final java.lang.String getOnclick()
Gets an onclick Javascript handler.


setOnclick

public final void setOnclick(java.lang.String onclick)
Sets an onclick Javascript handler.


getOndblclick

public final java.lang.String getOndblclick()
Gets an ondblclick Javascript handler.


setOndblclick

public final void setOndblclick(java.lang.String ondblclick)
Sets an ondblclick Javascript handler.


getOnmousedown

public final java.lang.String getOnmousedown()
Gets an onmousedown Javascript handler.


setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)
Sets an onmousedown Javascript handler.


getOnmouseup

public final java.lang.String getOnmouseup()
Gets an onmouseup Javascript handler.


setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)
Sets an onmouseup Javascript handler.


getOnmouseover

public final java.lang.String getOnmouseover()
Gets an onmouseover Javascript handler.


setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)
Sets an onmouseover Javascript handler.


getOnmousemove

public final java.lang.String getOnmousemove()
Gets an onmousemove Javascript handler.


setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)
Sets an onmousemove Javascript handler.


getOnmouseout

public final java.lang.String getOnmouseout()
Gets an onmouseout Javascript handler.


setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)
Sets an onmouseout Javascript handler.


getOnkeypress

public final java.lang.String getOnkeypress()
Gets an onkeypress Javascript handler.


setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)
Sets an onkeypress Javascript handler.


getOnkeydown

public final java.lang.String getOnkeydown()
Gets an onkeydown Javascript handler.


setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)
Sets an onkeydown Javascript handler.


getOnkeyup

public final java.lang.String getOnkeyup()
Gets an onkeyup Javascript handler.


setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)
Sets an onkeyup Javascript handler.


getIcon

public final java.lang.String getIcon()
Gets The text 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.


setIcon

public final void setIcon(java.lang.String icon)
Sets The text 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.


getText

public final java.lang.String getText()
Gets The text to render as a link to launch the popup panel. If the 'trigger' facet is defined, then this attribute is ignored.


setText

public final void setText(java.lang.String text)
Sets The text to render as a link to launch the popup panel. If the 'trigger' facet is defined, then this attribute is ignored.


getTitle

public final java.lang.String getTitle()
Gets The title of the panel when visible. The titlebar is not rendered if this attribute is not specified.


setTitle

public final void setTitle(java.lang.String title)
Sets The title of the panel when visible. The titlebar is not rendered if this attribute is not specified.


isModal

public final boolean isModal()
Gets 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.


setModal

public final void setModal(boolean modal)
Sets 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.


getAlignment

public final java.lang.String getAlignment()
Gets The position of the content container when visible. Defaults to "none" (appears relative control), if not specified. Other values are "center" (centered on screen).


setAlignment

public final void setAlignment(java.lang.String alignment)
Sets The position of the content container when visible. Defaults to "none" (appears relative control), if not specified. Other values are "center" (centered on screen).


getContentStyle

public final java.lang.String getContentStyle()
Gets The inline style of the content region.


setContentStyle

public final void setContentStyle(java.lang.String contentStyle)
Sets The inline style of the content region.


getTriggerStyle

public final java.lang.String getTriggerStyle()
Gets The inline style of the trigger. This style will be applied trigger specified by either the text and/or icon attribute, or the 'trigger' facet.


setTriggerStyle

public final void setTriggerStyle(java.lang.String triggerStyle)
Sets The inline style of the trigger. This style will be applied trigger specified by either the text and/or icon attribute, or the 'trigger' facet.


getWidth

public final int getWidth()
Gets Set the width of the popup. If not present the width defaults to the width of the content.


setWidth

public final void setWidth(int width)
Sets Set the width of the popup. If not present the width defaults to the width of the content.


getHeight

public final int getHeight()
Gets Set the height of the popup. If not present the width defaults to the height of the content.


setHeight

public final void setHeight(int height)
Sets Set the height of the popup. If not present the width defaults to the height of the content.


getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIXPanel

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXPanel


Copyright © 2001-2007 The Apache Software Foundation. All Rights Reserved.