org.apache.myfaces.custom.popup
Class HtmlPopup

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.popup.AbstractHtmlPopup
              org.apache.myfaces.custom.popup.HtmlPopup

All Implemented Interfaces:

javax.faces.component.StateHolder, EventAware, UniversalProperties, UserRoleAware

public class HtmlPopup
extends AbstractHtmlPopup

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

HtmlPopup()

Method Summary

java.lang.Boolean	getClosePopupOnExitingElement() Close the popup when the triggering element is left.
java.lang.Boolean	getClosePopupOnExitingPopup() Close the popup when the popup itself is left.
java.lang.String	getDir() HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
java.lang.Integer	getDisplayAtDistanceX() Pop the panel up in horizontal distance of x pixels from event.
java.lang.Integer	getDisplayAtDistanceY() Pop the panel up in vertical distance of y pixels from event.
java.lang.String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
java.lang.String	getFamily()
java.lang.String	getLang() HTML: The base language of this document.
java.lang.String	getLayout() The type of layout markup to use when rendering this group.
java.lang.String	getOnclick() HTML: Script to be invoked when the element is clicked.
java.lang.String	getOndblclick() HTML: Script to be invoked when the element is double-clicked.
java.lang.String	getOnkeydown() HTML: Script to be invoked when a key is pressed down over this element.
java.lang.String	getOnkeypress() HTML: Script to be invoked when a key is pressed over this element.
java.lang.String	getOnkeyup() HTML: Script to be invoked when a key is released over this element.
java.lang.String	getOnmousedown() HTML: Script to be invoked when the pointing device is pressed over this element.
java.lang.String	getOnmousemove() HTML: Script to be invoked when the pointing device is moved while it is in this element.
java.lang.String	getOnmouseout() HTML: Script to be invoked when the pointing device is moves out of this element.
java.lang.String	getOnmouseover() HTML: Script to be invoked when the pointing device is moved into this element.
java.lang.String	getOnmouseup() HTML: Script to be invoked when the pointing device is released over this element.
java.lang.String	getStyle() HTML: CSS styling instructions.
java.lang.String	getStyleClass() The CSS class for this element.
java.lang.String	getTitle() HTML: An advisory title for this element.
java.lang.String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setClosePopupOnExitingElement(java.lang.Boolean closePopupOnExitingElement)
void	setClosePopupOnExitingPopup(java.lang.Boolean closePopupOnExitingPopup)
void	setDir(java.lang.String dir)
void	setDisplayAtDistanceX(java.lang.Integer displayAtDistanceX)
void	setDisplayAtDistanceY(java.lang.Integer displayAtDistanceY)
void	setEnabledOnUserRole(java.lang.String enabledOnUserRole)
void	setLang(java.lang.String lang)
void	setLayout(java.lang.String layout)
void	setOnclick(java.lang.String onclick)
void	setOndblclick(java.lang.String ondblclick)
void	setOnkeydown(java.lang.String onkeydown)
void	setOnkeypress(java.lang.String onkeypress)
void	setOnkeyup(java.lang.String onkeyup)
void	setOnmousedown(java.lang.String onmousedown)
void	setOnmousemove(java.lang.String onmousemove)
void	setOnmouseout(java.lang.String onmouseout)
void	setOnmouseover(java.lang.String onmouseover)
void	setOnmouseup(java.lang.String onmouseup)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setTitle(java.lang.String title)
void	setVisibleOnUserRole(java.lang.String visibleOnUserRole)

Methods inherited from class org.apache.myfaces.custom.popup.AbstractHtmlPopup

getPopup, getRendersChildren, isRendered, setPopup

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlPopup

public HtmlPopup()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getStyle

public java.lang.String getStyle()

Description copied from class: AbstractHtmlPopup

HTML: CSS styling instructions.

Specified by:

getStyle in class AbstractHtmlPopup

setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()

Description copied from class: AbstractHtmlPopup

The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:

getStyleClass in class AbstractHtmlPopup

setStyleClass

public void setStyleClass(java.lang.String styleClass)

getDisplayAtDistanceX

public java.lang.Integer getDisplayAtDistanceX()

Description copied from class: AbstractHtmlPopup

Pop the panel up in horizontal distance of x pixels from event.

Specified by:

getDisplayAtDistanceX in class AbstractHtmlPopup

setDisplayAtDistanceX

public void setDisplayAtDistanceX(java.lang.Integer displayAtDistanceX)

getDisplayAtDistanceY

public java.lang.Integer getDisplayAtDistanceY()

Description copied from class: AbstractHtmlPopup

Pop the panel up in vertical distance of y pixels from event.

Specified by:

getDisplayAtDistanceY in class AbstractHtmlPopup

setDisplayAtDistanceY

public void setDisplayAtDistanceY(java.lang.Integer displayAtDistanceY)

getClosePopupOnExitingElement

public java.lang.Boolean getClosePopupOnExitingElement()

Description copied from class: AbstractHtmlPopup

Close the popup when the triggering element is left.

Specified by:

getClosePopupOnExitingElement in class AbstractHtmlPopup

setClosePopupOnExitingElement

public void setClosePopupOnExitingElement(java.lang.Boolean closePopupOnExitingElement)

getClosePopupOnExitingPopup

public java.lang.Boolean getClosePopupOnExitingPopup()

Description copied from class: AbstractHtmlPopup

Close the popup when the popup itself is left.

Specified by:

getClosePopupOnExitingPopup in class AbstractHtmlPopup

setClosePopupOnExitingPopup

public void setClosePopupOnExitingPopup(java.lang.Boolean closePopupOnExitingPopup)

getLayout

public java.lang.String getLayout()

Description copied from class: AbstractHtmlPopup

The type of layout markup to use when rendering this group. If the value is "block" the renderer must produce an HTML "div" element. If the value is "none", no tag is rendered on the output and instead, onmouseover and onmouseout properties are modified for children components. Otherwise HTML "span" element must be produced.

Specified by:

getLayout in class AbstractHtmlPopup

Returns:

the new layout value

setLayout

public void setLayout(java.lang.String layout)

getOnclick

public java.lang.String getOnclick()

Description copied from interface: EventAware

HTML: Script to be invoked when the element is clicked.

setOnclick

public void setOnclick(java.lang.String onclick)

getOndblclick

public java.lang.String getOndblclick()

Description copied from interface: EventAware

HTML: Script to be invoked when the element is double-clicked.

setOndblclick

public void setOndblclick(java.lang.String ondblclick)

getOnkeydown

public java.lang.String getOnkeydown()

Description copied from interface: EventAware

HTML: Script to be invoked when a key is pressed down over this element.

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

getOnkeypress

public java.lang.String getOnkeypress()

Description copied from interface: EventAware

HTML: Script to be invoked when a key is pressed over this element.

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

getOnkeyup

public java.lang.String getOnkeyup()

Description copied from interface: EventAware

HTML: Script to be invoked when a key is released over this element.

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

getOnmousedown

public java.lang.String getOnmousedown()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is pressed over this element.

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

getOnmousemove

public java.lang.String getOnmousemove()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is moved while it is in this element.

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

getOnmouseout

public java.lang.String getOnmouseout()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is moves out of this element.

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

getOnmouseover

public java.lang.String getOnmouseover()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is moved into this element.

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

getOnmouseup

public java.lang.String getOnmouseup()

Description copied from interface: EventAware

HTML: Script to be invoked when the pointing device is released over this element.

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

getDir

public java.lang.String getDir()

Description copied from interface: UniversalProperties

HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

setDir

public void setDir(java.lang.String dir)

getLang

public java.lang.String getLang()

Description copied from interface: UniversalProperties

HTML: The base language of this document.

setLang

public void setLang(java.lang.String lang)

getTitle

public java.lang.String getTitle()

Description copied from interface: UniversalProperties

HTML: An advisory title for this element. Often used by the user agent as a tooltip.

setTitle

public void setTitle(java.lang.String title)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase