org.apache.myfaces.custom.popup
Class AbstractHtmlPopup

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HtmlPopup

public abstract class AbstractHtmlPopup
extends javax.faces.component.UIComponentBase
implements UniversalProperties, EventAware, UserRoleAware

Renders a popup which displays on a mouse event. Unless otherwise specified, all attributes accept static values or EL expressions.

Since:

1.1.7

Version:

$Revision: 1097467 $ $Date: 2011-04-28 09:11:52 -0500 (Thu, 28 Apr 2011) $

Author:

Martin Marinschek (latest modification by $Author: lu4242 $)

Field Summary

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

Fields inherited from class javax.faces.component.UIComponent

bindings

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

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

AbstractHtmlPopup()

Method Summary

abstract java.lang.Boolean	getClosePopupOnExitingElement() Close the popup when the triggering element is left.
abstract java.lang.Boolean	getClosePopupOnExitingPopup() Close the popup when the popup itself is left.
abstract java.lang.Integer	getDisplayAtDistanceX() Pop the panel up in horizontal distance of x pixels from event.
abstract java.lang.Integer	getDisplayAtDistanceY() Pop the panel up in vertical distance of y pixels from event.
abstract java.lang.String	getLayout() The type of layout markup to use when rendering this group.
javax.faces.component.UIComponent	getPopup()
boolean	getRendersChildren()
abstract java.lang.String	getStyle() HTML: CSS styling instructions.
abstract java.lang.String	getStyleClass() The CSS class for this element.
boolean	isRendered()
void	setPopup(javax.faces.component.UIComponent popup)

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getFamily, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.component.UniversalProperties

getDir, getLang, getTitle

Methods inherited from interface org.apache.myfaces.component.EventAware

getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup

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

getEnabledOnUserRole, getVisibleOnUserRole, setEnabledOnUserRole, setVisibleOnUserRole

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

AbstractHtmlPopup

public AbstractHtmlPopup()

Method Detail

setPopup

public void setPopup(javax.faces.component.UIComponent popup)

getPopup

public javax.faces.component.UIComponent getPopup()

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class javax.faces.component.UIComponentBase

isRendered

public boolean isRendered()

Overrides:

isRendered in class javax.faces.component.UIComponentBase

getStyle

public abstract java.lang.String getStyle()

HTML: CSS styling instructions.

getStyleClass

public abstract java.lang.String getStyleClass()

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

getDisplayAtDistanceX

public abstract java.lang.Integer getDisplayAtDistanceX()

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

getDisplayAtDistanceY

public abstract java.lang.Integer getDisplayAtDistanceY()

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

getClosePopupOnExitingElement

public abstract java.lang.Boolean getClosePopupOnExitingElement()

Close the popup when the triggering element is left.

getClosePopupOnExitingPopup

public abstract java.lang.Boolean getClosePopupOnExitingPopup()

Close the popup when the popup itself is left.

getLayout

public abstract java.lang.String getLayout()

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.

Returns:

the new layout value