com.liferay.faces.alloy.component.dialog

Class DialogBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

javax.faces.component.html.HtmlPanelGroup

com.liferay.faces.alloy.component.panelgroup.PanelGroupBase

com.liferay.faces.alloy.component.panelgroup.PanelGroupBlockLayout

com.liferay.faces.alloy.component.dialog.DialogBase

All Implemented Interfaces:

com.liferay.faces.util.component.ClientComponent, com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

Dialog

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class DialogBase
extends PanelGroupBlockLayout
implements com.liferay.faces.util.component.Styleable, com.liferay.faces.util.component.ClientComponent

Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DialogBase.DialogPropertyKeys

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlPanelGroup

javax.faces.component.html.HtmlPanelGroup.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY

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

Fields inherited from interface com.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Fields inherited from interface com.liferay.faces.util.component.ClientComponent

CLIENT_KEY

Constructor Summary

Constructors

Constructor and Description
DialogBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getClientKey() clientKey attribute description: The key name that can be used to reference the component on the client.
String	getHeaderText() headerText attribute description: The text to place in the header of the component.
String	getHeight() height attribute description: The height of the dialog/popover.
String	getStyleClass() styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
String	getWidth() width attribute description: The width of the dialog/popover.
Integer	getzIndex() zIndex attribute description: Specifies the stack order of the component.
boolean	isAutoShow() autoShow attribute description: When true, the component is visible initially.
boolean	isDismissible() dismissible attribute description: When true, the overlay window is automatically hidden when the user clicks outside of it.
boolean	isHideIconRendered() hideIconRendered attribute description: When true, an "x" is placed in the upper right corner that the user can click on to hide/dismiss the overlay window.
boolean	isModal() modal attribute description: When true, the user must interact with the child dialog window before continuing to interact with the parent.
void	setAutoShow(boolean autoShow) autoShow attribute description: When true, the component is visible initially.
void	setClientKey(String clientKey) clientKey attribute description: The key name that can be used to reference the component on the client.
void	setDismissible(boolean dismissible) dismissible attribute description: When true, the overlay window is automatically hidden when the user clicks outside of it.
void	setHeaderText(String headerText) headerText attribute description: The text to place in the header of the component.
void	setHeight(String height) height attribute description: The height of the dialog/popover.
void	setHideIconRendered(boolean hideIconRendered) hideIconRendered attribute description: When true, an "x" is placed in the upper right corner that the user can click on to hide/dismiss the overlay window.
void	setModal(boolean modal) modal attribute description: When true, the user must interact with the child dialog window before continuing to interact with the parent.
void	setWidth(String width) width attribute description: The width of the dialog/popover.
void	setzIndex(Integer zIndex) zIndex attribute description: Specifies the stack order of the component.

Methods inherited from class com.liferay.faces.alloy.component.panelgroup.PanelGroupBlockLayout

getLayout

Methods inherited from class javax.faces.component.html.HtmlPanelGroup

getDefaultEventName, getEventNames, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getStyle, setLayout, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setStyle, setStyleClass

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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

Methods inherited from interface com.liferay.faces.util.component.Styleable

getStyle, setStyle, setStyleClass

Methods inherited from interface com.liferay.faces.util.component.ClientComponent

getClientId

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

DialogBase

public DialogBase()

Method Detail

isAutoShow

public boolean isAutoShow()

autoShow attribute description:

When true, the component is visible initially.

setAutoShow

public void setAutoShow(boolean autoShow)

autoShow attribute description:

When true, the component is visible initially.

getClientKey

public String getClientKey()

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

getClientKey in interface com.liferay.faces.util.component.ClientComponent

setClientKey

public void setClientKey(String clientKey)

clientKey attribute description:

The key name that can be used to reference the component on the client.

Specified by:

setClientKey in interface com.liferay.faces.util.component.ClientComponent

isDismissible

public boolean isDismissible()

dismissible attribute description:

When true, the overlay window is automatically hidden when the user clicks outside of it.

setDismissible

public void setDismissible(boolean dismissible)

dismissible attribute description:

When true, the overlay window is automatically hidden when the user clicks outside of it.

getHeaderText

public String getHeaderText()

headerText attribute description:

The text to place in the header of the component.

setHeaderText

public void setHeaderText(String headerText)

headerText attribute description:

The text to place in the header of the component.

getHeight

public String getHeight()

height attribute description:

The height of the dialog/popover.

setHeight

public void setHeight(String height)

height attribute description:

The height of the dialog/popover.

isHideIconRendered

public boolean isHideIconRendered()

hideIconRendered attribute description:

When true, an "x" is placed in the upper right corner that the user can click on to hide/dismiss the overlay window.

setHideIconRendered

public void setHideIconRendered(boolean hideIconRendered)

hideIconRendered attribute description:

When true, an "x" is placed in the upper right corner that the user can click on to hide/dismiss the overlay window.

isModal

public boolean isModal()

modal attribute description:

When true, the user must interact with the child dialog window before continuing to interact with the parent.

setModal

public void setModal(boolean modal)

modal attribute description:

When true, the user must interact with the child dialog window before continuing to interact with the parent.

getStyleClass

public String getStyleClass()

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

Overrides:

getStyleClass in class PanelGroupBase

getWidth

public String getWidth()

width attribute description:

The width of the dialog/popover.

setWidth

public void setWidth(String width)

width attribute description:

The width of the dialog/popover.

getzIndex

public Integer getzIndex()

zIndex attribute description:

Specifies the stack order of the component. The default value is a constant from the Liferay.zIndex JavaScript object.

setzIndex

public void setzIndex(Integer zIndex)

zIndex attribute description:

Specifies the stack order of the component. The default value is a constant from the Liferay.zIndex JavaScript object.