org.apache.myfaces.tobago.component
Class UIPopup

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              org.apache.myfaces.tobago.internal.component.AbstractUIPanelBase
                  org.apache.myfaces.tobago.internal.component.AbstractUIPopup
                      org.apache.myfaces.tobago.component.UIPopup

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, DeprecatedDimension, OnComponentCreated, OnComponentPopulated, Position, SupportsMarkup, Configurable, LayoutBase, LayoutBox, LayoutContainer

public class UIPopup
extends AbstractUIPopup
implements SupportsMarkup

Renders a popup panel. The popup gets a grid layout manager with columns="auto" and rows="auto" as definition. So a popup should contain only one layout component. The default layout manager can be overwritten with the layout facet. UIComponent class, generated from template component1.2.stg with class PopupTagDeclaration.

Field Summary

static String

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface org.apache.myfaces.tobago.component.OnComponentCreated

MARKER

Fields inherited from interface org.apache.myfaces.tobago.component.OnComponentPopulated

MARKER

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIPopup()

Method Summary

Measure	getBorderBottom() This attribute is for internal use only.
Measure	getBorderLeft() This attribute is for internal use only.
Measure	getBorderRight() This attribute is for internal use only.
Measure	getBorderTop() This attribute is for internal use only.
Integer	getColumnSpan()
Measure	getCurrentHeight() This value will usually be set by the layout manager.
Markup	getCurrentMarkup()
Measure	getCurrentWidth() This value will usually be set by the layout manager.
Display	getDisplay() This attribute is for internal use only.
Measure	getHeight() The height of the component in the UI.
Integer	getHorizontalIndex() This attribute is for internal use only.
Measure	getLeft() This value will usually be set by the layout manager.
Measure	getMarginBottom()
Measure	getMarginLeft()
Measure	getMarginRight()
Measure	getMarginTop()
Markup	getMarkup()
Measure	getMaximumHeight()
Measure	getMaximumWidth()
Measure	getMinimumHeight()
Measure	getMinimumWidth()
Measure	getPaddingBottom() This attribute is for internal use only.
Measure	getPaddingLeft() This attribute is for internal use only.
Measure	getPaddingRight() This attribute is for internal use only.
Measure	getPaddingTop() This attribute is for internal use only.
Measure	getPreferredHeight()
Measure	getPreferredWidth()
Integer	getRowSpan()
Measure	getTop() This value will usually be set by the layout manager.
Integer	getVerticalIndex() This attribute is for internal use only.
Measure	getWidth() The width of the component in the UI.
Integer	getZIndex() Represents the visibility order of the popup.
boolean	isModal()
boolean	isOverflowX() This attribute is for internal use only.
boolean	isOverflowY() This attribute is for internal use only.
void	restoreState(javax.faces.context.FacesContext context, Object componentState)
Object	saveState(javax.faces.context.FacesContext context)
void	setBorderBottom(Measure borderBottom)
void	setBorderLeft(Measure borderLeft)
void	setBorderRight(Measure borderRight)
void	setBorderTop(Measure borderTop)
void	setColumnSpan(Integer columnSpan)
void	setCurrentHeight(Measure currentHeight)
void	setCurrentMarkup(Markup currentMarkup)
void	setCurrentWidth(Measure currentWidth)
void	setDisplay(Display display)
void	setHeight(Measure height)
void	setHorizontalIndex(Integer horizontalIndex)
void	setLeft(Measure left)
void	setMarginBottom(Measure marginBottom)
void	setMarginLeft(Measure marginLeft)
void	setMarginRight(Measure marginRight)
void	setMarginTop(Measure marginTop)
void	setMarkup(Markup markup)
void	setMaximumHeight(Measure maximumHeight)
void	setMaximumWidth(Measure maximumWidth)
void	setMinimumHeight(Measure minimumHeight)
void	setMinimumWidth(Measure minimumWidth)
void	setModal(boolean modal)
void	setOverflowX(boolean overflowX)
void	setOverflowY(boolean overflowY)
void	setPaddingBottom(Measure paddingBottom)
void	setPaddingLeft(Measure paddingLeft)
void	setPaddingRight(Measure paddingRight)
void	setPaddingTop(Measure paddingTop)
void	setPreferredHeight(Measure preferredHeight)
void	setPreferredWidth(Measure preferredWidth)
void	setRowSpan(Integer rowSpan)
void	setTop(Measure top)
void	setVerticalIndex(Integer verticalIndex)
void	setWidth(Measure width)
void	setZIndex(Integer zIndex)

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPopup

encodeEnd, getComponents, getLayoutManager, isLayoutChildren, isRendered, onComponentCreated, onComponentPopulated, processDecodes, processUpdates, processValidators, setActivated, setLayoutManager

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, 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.tobago.config.Configurable

getRendererType

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIPopup

public UIPopup()

Method Detail

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface SupportsMarkup

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface SupportsMarkup

getZIndex

public Integer getZIndex()

Represents the visibility order of the popup. The renderer may implemented this visibility by the CSS z-index.

setZIndex

public void setZIndex(Integer zIndex)

Specified by:

setZIndex in class AbstractUIPopup

getMarginLeft

public Measure getMarginLeft()

Specified by:

getMarginLeft in interface LayoutBase

setMarginLeft

public void setMarginLeft(Measure marginLeft)

Specified by:

setMarginLeft in interface LayoutBase

getMinimumHeight

public Measure getMinimumHeight()

Specified by:

getMinimumHeight in interface LayoutBase

setMinimumHeight

public void setMinimumHeight(Measure minimumHeight)

Specified by:

setMinimumHeight in interface LayoutBase

getBorderLeft

public Measure getBorderLeft()

This attribute is for internal use only.

Specified by:

getBorderLeft in interface LayoutBox

setBorderLeft

public void setBorderLeft(Measure borderLeft)

Specified by:

setBorderLeft in interface LayoutBox

getHeight

public Measure getHeight()

The height of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.

Specified by:

getHeight in interface DeprecatedDimension

Specified by:

getHeight in interface LayoutBase

Specified by:

getHeight in class AbstractUIPopup

setHeight

public void setHeight(Measure height)

Specified by:

setHeight in interface DeprecatedDimension

Specified by:

setHeight in interface LayoutBase

Specified by:

setHeight in class AbstractUIPopup

getMinimumWidth

public Measure getMinimumWidth()

Specified by:

getMinimumWidth in interface LayoutBase

setMinimumWidth

public void setMinimumWidth(Measure minimumWidth)

Specified by:

setMinimumWidth in interface LayoutBase

isOverflowX

public boolean isOverflowX()

This attribute is for internal use only.

Specified by:

isOverflowX in interface LayoutContainer

setOverflowX

public void setOverflowX(boolean overflowX)

Specified by:

setOverflowX in interface LayoutContainer

getRowSpan

public Integer getRowSpan()

setRowSpan

public void setRowSpan(Integer rowSpan)

isOverflowY

public boolean isOverflowY()

This attribute is for internal use only.

Specified by:

isOverflowY in interface LayoutContainer

setOverflowY

public void setOverflowY(boolean overflowY)

Specified by:

setOverflowY in interface LayoutContainer

getLeft

public Measure getLeft()

This value will usually be set by the layout manager.

Specified by:

getLeft in interface Position

Specified by:

getLeft in interface LayoutBase

Specified by:

getLeft in class AbstractUIPopup

setLeft

public void setLeft(Measure left)

Specified by:

setLeft in interface Position

Specified by:

setLeft in interface LayoutBase

Specified by:

setLeft in class AbstractUIPopup

getColumnSpan

public Integer getColumnSpan()

setColumnSpan

public void setColumnSpan(Integer columnSpan)

getBorderRight

public Measure getBorderRight()

This attribute is for internal use only.

Specified by:

getBorderRight in interface LayoutBox

setBorderRight

public void setBorderRight(Measure borderRight)

Specified by:

setBorderRight in interface LayoutBox

isModal

public boolean isModal()

setModal

public void setModal(boolean modal)

getPaddingBottom

public Measure getPaddingBottom()

This attribute is for internal use only.

Specified by:

getPaddingBottom in interface LayoutBox

setPaddingBottom

public void setPaddingBottom(Measure paddingBottom)

Specified by:

setPaddingBottom in interface LayoutBox

getMaximumHeight

public Measure getMaximumHeight()

Specified by:

getMaximumHeight in interface LayoutBase

setMaximumHeight

public void setMaximumHeight(Measure maximumHeight)

Specified by:

setMaximumHeight in interface LayoutBase

getTop

public Measure getTop()

This value will usually be set by the layout manager.

Specified by:

getTop in interface Position

Specified by:

getTop in interface LayoutBase

Specified by:

getTop in class AbstractUIPopup

setTop

public void setTop(Measure top)

Specified by:

setTop in interface Position

Specified by:

setTop in interface LayoutBase

Specified by:

setTop in class AbstractUIPopup

getCurrentWidth

public Measure getCurrentWidth()

This value will usually be set by the layout manager. It holds the current width computed by the layout manager.

Specified by:

getCurrentWidth in interface LayoutBase

setCurrentWidth

public void setCurrentWidth(Measure currentWidth)

Specified by:

setCurrentWidth in interface LayoutBase

getPaddingTop

public Measure getPaddingTop()

This attribute is for internal use only.

Specified by:

getPaddingTop in interface LayoutBox

setPaddingTop

public void setPaddingTop(Measure paddingTop)

Specified by:

setPaddingTop in interface LayoutBox

getMarginTop

public Measure getMarginTop()

Specified by:

getMarginTop in interface LayoutBase

setMarginTop

public void setMarginTop(Measure marginTop)

Specified by:

setMarginTop in interface LayoutBase

getMarginRight

public Measure getMarginRight()

Specified by:

getMarginRight in interface LayoutBase

setMarginRight

public void setMarginRight(Measure marginRight)

Specified by:

setMarginRight in interface LayoutBase

getWidth

public Measure getWidth()

The width of the component in the UI. This value will usually be set by the layout manager, but can be set explicitly here.

Specified by:

getWidth in interface DeprecatedDimension

Specified by:

getWidth in interface LayoutBase

Specified by:

getWidth in class AbstractUIPopup

setWidth

public void setWidth(Measure width)

Specified by:

setWidth in interface DeprecatedDimension

Specified by:

setWidth in interface LayoutBase

Specified by:

setWidth in class AbstractUIPopup

getCurrentHeight

public Measure getCurrentHeight()

This value will usually be set by the layout manager. It holds the current height computed by the layout manager.

Specified by:

getCurrentHeight in interface LayoutBase

setCurrentHeight

public void setCurrentHeight(Measure currentHeight)

Specified by:

setCurrentHeight in interface LayoutBase

getPreferredHeight

public Measure getPreferredHeight()

Specified by:

getPreferredHeight in interface LayoutBase

setPreferredHeight

public void setPreferredHeight(Measure preferredHeight)

Specified by:

setPreferredHeight in interface LayoutBase

getDisplay

public Display getDisplay()

This attribute is for internal use only.

setDisplay

public void setDisplay(Display display)

getBorderBottom

public Measure getBorderBottom()

This attribute is for internal use only.

Specified by:

getBorderBottom in interface LayoutBox

setBorderBottom

public void setBorderBottom(Measure borderBottom)

Specified by:

setBorderBottom in interface LayoutBox

getMaximumWidth

public Measure getMaximumWidth()

Specified by:

getMaximumWidth in interface LayoutBase

setMaximumWidth

public void setMaximumWidth(Measure maximumWidth)

Specified by:

setMaximumWidth in interface LayoutBase

getPaddingLeft

public Measure getPaddingLeft()

This attribute is for internal use only.

Specified by:

getPaddingLeft in interface LayoutBox

setPaddingLeft

public void setPaddingLeft(Measure paddingLeft)

Specified by:

setPaddingLeft in interface LayoutBox

getPaddingRight

public Measure getPaddingRight()

This attribute is for internal use only.

Specified by:

getPaddingRight in interface LayoutBox

setPaddingRight

public void setPaddingRight(Measure paddingRight)

Specified by:

setPaddingRight in interface LayoutBox

getPreferredWidth

public Measure getPreferredWidth()

Specified by:

getPreferredWidth in interface LayoutBase

setPreferredWidth

public void setPreferredWidth(Measure preferredWidth)

Specified by:

setPreferredWidth in interface LayoutBase

getMarginBottom

public Measure getMarginBottom()

Specified by:

getMarginBottom in interface LayoutBase

setMarginBottom

public void setMarginBottom(Measure marginBottom)

Specified by:

setMarginBottom in interface LayoutBase

getVerticalIndex

public Integer getVerticalIndex()

This attribute is for internal use only.

setVerticalIndex

public void setVerticalIndex(Integer verticalIndex)

getBorderTop

public Measure getBorderTop()

This attribute is for internal use only.

Specified by:

getBorderTop in interface LayoutBox

setBorderTop

public void setBorderTop(Measure borderTop)

Specified by:

setBorderTop in interface LayoutBox

getCurrentMarkup

public Markup getCurrentMarkup()

Specified by:

getCurrentMarkup in interface SupportsMarkup

Specified by:

getCurrentMarkup in interface Configurable

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)

Specified by:

setCurrentMarkup in interface SupportsMarkup

getHorizontalIndex

public Integer getHorizontalIndex()

This attribute is for internal use only.

setHorizontalIndex

public void setHorizontalIndex(Integer horizontalIndex)

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object componentState)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class AbstractUIPopup

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class AbstractUIPopup