org.apache.myfaces.custom.popup
Class AbstractHtmlPopup

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.apache.myfaces.custom.popup.AbstractHtmlPopup
All Implemented Interfaces:
EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, EventAware, org.apache.myfaces.component.UniversalProperties, org.apache.myfaces.component.UserRoleAware

public abstract class AbstractHtmlPopup
extends javax.faces.component.UIComponentBase
implements org.apache.myfaces.component.UniversalProperties, EventAware, org.apache.myfaces.component.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: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (miƩ, 03 sep 2008) $
Author:
Martin Marinschek (latest modification by $Author: lu4242 $)

Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
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  Boolean getClosePopupOnExitingElement()
          Close the popup when the triggering element is left.
abstract  Boolean getClosePopupOnExitingPopup()
          Close the popup when the popup itself is left.
abstract  Integer getDisplayAtDistanceX()
          Pop the panel up in horizontal distance of x pixels from event.
abstract  Integer getDisplayAtDistanceY()
          Pop the panel up in vertical distance of y pixels from event.
abstract  String getLayout()
          The type of layout markup to use when rendering this group.
 javax.faces.component.UIComponent getPopup()
           
 boolean getRendersChildren()
           
abstract  String getStyle()
          HTML: CSS styling instructions.
abstract  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
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFamily, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
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 String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final 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 String getStyle()
HTML: CSS styling instructions.


getStyleClass

public abstract String getStyleClass()
The CSS class for this element. Corresponds to the HTML 'class' attribute.


getDisplayAtDistanceX

public abstract Integer getDisplayAtDistanceX()
Pop the panel up in horizontal distance of x pixels from event.


getDisplayAtDistanceY

public abstract Integer getDisplayAtDistanceY()
Pop the panel up in vertical distance of y pixels from event.


getClosePopupOnExitingElement

public abstract Boolean getClosePopupOnExitingElement()
Close the popup when the triggering element is left.


getClosePopupOnExitingPopup

public abstract Boolean getClosePopupOnExitingPopup()
Close the popup when the popup itself is left.


getLayout

public abstract 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


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.