org.primefaces.extensions.component.blockui

Class BlockUI

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.extensions.component.blockui.BlockUI

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.primefaces.component.api.Widget

public class BlockUI
extends javax.faces.component.UIComponentBase
implements org.primefaces.component.api.Widget

BlockUI component.

Since:

0.2

Version:

$Revision$

Author:

Oleg Varaksin / last modified by $Author$

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BlockUI.PropertyKeys Properties that are tracked by state saving.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
BlockUI()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContent()
java.lang.String	getCss()
java.lang.String	getCssOverlay()
java.lang.String	getEvent()
java.lang.String	getFamily()
java.lang.String	getSource()
java.lang.String	getTarget()
int	getTimeout()
java.lang.String	getWidgetVar()
boolean	isAutoShow()
boolean	isCenterX()
boolean	isCenterY()
java.lang.String	resolveWidgetVar()
void	setAutoShow(boolean autoShow)
void	setCenterX(boolean centerX)
void	setCenterY(boolean centerY)
void	setContent(java.lang.String content)
void	setCss(java.lang.String css)
void	setCssOverlay(java.lang.String cssOverlay)
void	setEvent(java.lang.String event)
void	setSource(java.lang.String source)
void	setTarget(java.lang.String target)
void	setTimeout(int timeout)
void	setWidgetVar(java.lang.String widgetVar)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

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

BlockUI

public BlockUI()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getWidgetVar

public java.lang.String getWidgetVar()

setWidgetVar

public void setWidgetVar(java.lang.String widgetVar)

setCss

public void setCss(java.lang.String css)

getCss

public java.lang.String getCss()

setCssOverlay

public void setCssOverlay(java.lang.String cssOverlay)

getCssOverlay

public java.lang.String getCssOverlay()

getSource

public java.lang.String getSource()

setSource

public void setSource(java.lang.String source)

getTarget

public java.lang.String getTarget()

setTarget

public void setTarget(java.lang.String target)

getContent

public java.lang.String getContent()

setContent

public void setContent(java.lang.String content)

getEvent

public java.lang.String getEvent()

setEvent

public void setEvent(java.lang.String event)

isAutoShow

public boolean isAutoShow()

setAutoShow

public void setAutoShow(boolean autoShow)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

isCenterX

public boolean isCenterX()

setCenterX

public void setCenterX(boolean centerX)

isCenterY

public boolean isCenterY()

setCenterY

public void setCenterY(boolean centerY)

resolveWidgetVar

public java.lang.String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface org.primefaces.component.api.Widget