|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIPanel
org.icefaces.ace.component.confirmationdialog.ConfirmationDialogBase
public class ConfirmationDialogBase
The Confirmation Dialog is a component that displays a dialog that asks users to confirm or cancel their actions. If position of dialog is out of place, try putting it as last child of body.
For more information, see the ConfirmationDialog Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
ConfirmationDialogBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.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 |
Constructor Summary | |
---|---|
ConfirmationDialogBase()
|
Method Summary | |
---|---|
java.lang.String |
getFamily()
|
java.lang.String |
getHeader()
Return the value of the header property. |
int |
getHeight()
Return the value of the height property. |
java.lang.String |
getHideEffect()
Return the value of the hideEffect property. |
java.lang.String |
getMessage()
Return the value of the message property. |
java.lang.String |
getPosition()
Return the value of the position property. |
java.lang.String |
getSeverity()
Return the value of the severity property. |
java.lang.String |
getShowEffect()
Return the value of the showEffect property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
java.lang.String |
getWidgetVar()
Return the value of the widgetVar property. |
int |
getWidth()
Return the value of the width property. |
int |
getZindex()
Return the value of the zindex property. |
boolean |
isClosable()
Return the value of the closable property. |
boolean |
isCloseOnEscape()
Return the value of the closeOnEscape property. |
boolean |
isDraggable()
Return the value of the draggable property. |
boolean |
isModal()
Return the value of the modal property. |
void |
setClosable(boolean closable)
Set the value of the closable property. |
void |
setCloseOnEscape(boolean closeOnEscape)
Set the value of the closeOnEscape property. |
void |
setDraggable(boolean draggable)
Set the value of the draggable property. |
void |
setHeader(java.lang.String header)
Set the value of the header property. |
void |
setHeight(int height)
Set the value of the height property. |
void |
setHideEffect(java.lang.String hideEffect)
Set the value of the hideEffect property. |
void |
setMessage(java.lang.String message)
Set the value of the message property. |
void |
setModal(boolean modal)
Set the value of the modal property. |
void |
setPosition(java.lang.String position)
Set the value of the position property. |
void |
setSeverity(java.lang.String severity)
Set the value of the severity property. |
void |
setShowEffect(java.lang.String showEffect)
Set the value of the showEffect property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
void |
setWidth(int width)
Set the value of the width property. |
void |
setZindex(int zindex)
Set the value of the zindex property. |
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, 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, 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 |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public ConfirmationDialogBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIPanel
public void setClosable(boolean closable)
Set the value of the closable
property.
Contents: Specifies if close button should be displayed or not.
setClosable
in interface IConfirmationDialog
public boolean isClosable()
Return the value of the closable
property.
Contents: Specifies if close button should be displayed or not. Default = 'true'.
isClosable
in interface IConfirmationDialog
public void setCloseOnEscape(boolean closeOnEscape)
Set the value of the closeOnEscape
property.
Contents: Specifies if dialog should be closed when escape key is pressed.
setCloseOnEscape
in interface IConfirmationDialog
public boolean isCloseOnEscape()
Return the value of the closeOnEscape
property.
Contents: Specifies if dialog should be closed when escape key is pressed. Default = 'true'.
isCloseOnEscape
in interface IConfirmationDialog
public void setDraggable(boolean draggable)
Set the value of the draggable
property.
Contents: Controls draggability.
setDraggable
in interface IConfirmationDialog
public boolean isDraggable()
Return the value of the draggable
property.
Contents: Controls draggability. Default = 'true'.
isDraggable
in interface IConfirmationDialog
public void setHeader(java.lang.String header)
Set the value of the header
property.
Contents: Text for the header.
setHeader
in interface IConfirmationDialog
public java.lang.String getHeader()
Return the value of the header
property.
Contents: Text for the header.
getHeader
in interface IConfirmationDialog
public void setHeight(int height)
Set the value of the height
property.
Contents: Height of the dialog in pixels.
setHeight
in interface IConfirmationDialog
public int getHeight()
Return the value of the height
property.
Contents: Height of the dialog in pixels. Default = 'Integer.MIN_VALUE'.
getHeight
in interface IConfirmationDialog
public void setHideEffect(java.lang.String hideEffect)
Set the value of the hideEffect
property.
Contents: Effect to use when hiding the dialog. Possible values are 'blind', 'clip', 'drop', 'explode, 'fade', 'fold', 'puff', 'slide', 'scale', 'bounce', 'highlight', and 'shake' (Some effects are not supported in IE browsers, see wiki page for more information).
setHideEffect
in interface IConfirmationDialog
public java.lang.String getHideEffect()
Return the value of the hideEffect
property.
Contents: Effect to use when hiding the dialog. Possible values are 'blind', 'clip', 'drop', 'explode, 'fade', 'fold', 'puff', 'slide', 'scale', 'bounce', 'highlight', and 'shake' (Some effects are not supported in IE browsers, see wiki page for more information).
getHideEffect
in interface IConfirmationDialog
public void setMessage(java.lang.String message)
Set the value of the message
property.
Contents: Text to be displayed in body.
setMessage
in interface IConfirmationDialog
public java.lang.String getMessage()
Return the value of the message
property.
Contents: Text to be displayed in body.
getMessage
in interface IConfirmationDialog
public void setModal(boolean modal)
Set the value of the modal
property.
Contents: Boolean value that specifies whether the document should be shielded with a partially transparent mask to require the user to close the Panel before being able to activate any elements in the document.
setModal
in interface IConfirmationDialog
public boolean isModal()
Return the value of the modal
property.
Contents: Boolean value that specifies whether the document should be shielded with a partially transparent mask to require the user to close the Panel before being able to activate any elements in the document. Default = 'false'.
isModal
in interface IConfirmationDialog
public void setPosition(java.lang.String position)
Set the value of the position
property.
Contents: Specifies where the dialog should be displayed. Possible values: 1) a single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'. 2) an array containing an x,y coordinate pair in pixel offset from left, top corner of viewport (e.g. [350,100]) 3) an array containing x,y position string values (e.g. ['right','top'] for top right corner).
setPosition
in interface IConfirmationDialog
public java.lang.String getPosition()
Return the value of the position
property.
Contents: Specifies where the dialog should be displayed. Possible values: 1) a single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'. 2) an array containing an x,y coordinate pair in pixel offset from left, top corner of viewport (e.g. [350,100]) 3) an array containing x,y position string values (e.g. ['right','top'] for top right corner).
getPosition
in interface IConfirmationDialog
public void setSeverity(java.lang.String severity)
Set the value of the severity
property.
Contents: Message severity for the dislayed icon. Value can be whatever is appended to ".ui-icon-" in the theme stylesheet.
setSeverity
in interface IConfirmationDialog
public java.lang.String getSeverity()
Return the value of the severity
property.
Contents: Message severity for the dislayed icon. Value can be whatever is appended to ".ui-icon-" in the theme stylesheet. Default = 'alert'.
getSeverity
in interface IConfirmationDialog
public void setShowEffect(java.lang.String showEffect)
Set the value of the showEffect
property.
Contents: Effect to use when showing the dialog. Possible values are 'blind', 'clip', 'drop', 'explode, 'fade', 'fold', 'puff', 'slide', 'scale', 'bounce', 'highlight', 'pulsate', and 'shake' (Some effects are not supported in IE7, see wiki page for more information).
setShowEffect
in interface IConfirmationDialog
public java.lang.String getShowEffect()
Return the value of the showEffect
property.
Contents: Effect to use when showing the dialog. Possible values are 'blind', 'clip', 'drop', 'explode, 'fade', 'fold', 'puff', 'slide', 'scale', 'bounce', 'highlight', 'pulsate', and 'shake' (Some effects are not supported in IE7, see wiki page for more information).
getShowEffect
in interface IConfirmationDialog
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Style class of the dialog container.
setStyleClass
in interface IConfirmationDialog
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class of the dialog container.
getStyleClass
in interface IConfirmationDialog
public void setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar
property.
Contents: Name of the widget to access client side api
setWidgetVar
in interface IConfirmationDialog
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: Name of the widget to access client side api
getWidgetVar
in interface IConfirmationDialog
public void setWidth(int width)
Set the value of the width
property.
Contents: Width of the dialog in pixels.
setWidth
in interface IConfirmationDialog
public int getWidth()
Return the value of the width
property.
Contents: Width of the dialog in pixels. Default = '300'.
getWidth
in interface IConfirmationDialog
public void setZindex(int zindex)
Set the value of the zindex
property.
Contents: zindex property to control overlapping with other elements.
setZindex
in interface IConfirmationDialog
public int getZindex()
Return the value of the zindex
property.
Contents: zindex property to control overlapping with other elements. Default = '1000'.
getZindex
in interface IConfirmationDialog
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |