|
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.dialog.DialogBase
public class DialogBase
The Dialog is a container component that can overlay other elements on page. Dialog has several customization options such as modal, resize, width, height, position. If position of dialog is out of place, try putting it as last child of body.
For more information, see the Dialog Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
DialogBase.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 | |
---|---|
DialogBase()
|
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
java.lang.String |
getDialogPosition()
Return the value of the dialogPosition property. |
java.util.Collection<java.lang.String> |
getEventNames()
|
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. |
int |
getMinHeight()
Return the value of the minHeight property. |
int |
getMinWidth()
Return the value of the minWidth property. |
java.lang.String |
getOnHide()
Return the value of the onHide property. |
java.lang.String |
getOnShow()
Return the value of the onShow property. |
java.lang.String |
getPosition()
Return the value of the position property. |
java.lang.String |
getRelativePosition()
Return the value of the relativePosition property. |
java.lang.String |
getRelativeTo()
Return the value of the relativeTo 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. |
boolean |
isResizable()
Return the value of the resizable property. |
boolean |
isShowHeader()
Return the value of the showHeader property. |
boolean |
isVisible()
Return the value of the visible property. |
void |
setClosable(boolean closable)
Set the value of the closable property. |
void |
setCloseOnEscape(boolean closeOnEscape)
Set the value of the closeOnEscape property. |
void |
setDialogPosition(java.lang.String dialogPosition)
Set the value of the dialogPosition 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 |
setMinHeight(int minHeight)
Set the value of the minHeight property. |
void |
setMinWidth(int minWidth)
Set the value of the minWidth property. |
void |
setModal(boolean modal)
Set the value of the modal property. |
void |
setOnHide(java.lang.String onHide)
Set the value of the onHide property. |
void |
setOnShow(java.lang.String onShow)
Set the value of the onShow property. |
void |
setPosition(java.lang.String position)
Set the value of the position property. |
void |
setRelativePosition(java.lang.String relativePosition)
Set the value of the relativePosition property. |
void |
setRelativeTo(java.lang.String relativeTo)
Set the value of the relativeTo property. |
void |
setResizable(boolean resizable)
Set the value of the resizable property. |
void |
setShowEffect(java.lang.String showEffect)
Set the value of the showEffect property. |
void |
setShowHeader(boolean showHeader)
Set the value of the showHeader property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setVisible(boolean visible)
Set the value of the visible 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 |
---|
addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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 |
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
---|
getClientBehaviors |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public DialogBase()
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: Boolean value that specifies whether the dialog should have a close button in the header.
setClosable
in interface IDialog
public boolean isClosable()
Return the value of the closable
property.
Contents: Boolean value that specifies whether the dialog should have a close button in the header. Default = 'true'.
isClosable
in interface IDialog
public void setCloseOnEscape(boolean closeOnEscape)
Set the value of the closeOnEscape
property.
Contents: Boolean value that Specifies whether the dialog should close when it has focus and the user presses the escape (ESC) key.
setCloseOnEscape
in interface IDialog
public boolean isCloseOnEscape()
Return the value of the closeOnEscape
property.
Contents: Boolean value that Specifies whether the dialog should close when it has focus and the user presses the escape (ESC) key. Default = 'true'.
isCloseOnEscape
in interface IDialog
public void setDialogPosition(java.lang.String dialogPosition)
Set the value of the dialogPosition
property.
Contents: The side of the dialog to position in relation to the target component. The format is "
setDialogPosition
in interface IDialog
public java.lang.String getDialogPosition()
Return the value of the dialogPosition
property.
Contents: The side of the dialog to position in relation to the target component. The format is "
getDialogPosition
in interface IDialog
public void setDraggable(boolean draggable)
Set the value of the draggable
property.
Contents: Boolean value whether to allow the user to drag the Panel using its header
setDraggable
in interface IDialog
public boolean isDraggable()
Return the value of the draggable
property.
Contents: Boolean value whether to allow the user to drag the Panel using its header Default = 'true'.
isDraggable
in interface IDialog
public void setHeader(java.lang.String header)
Set the value of the header
property.
Contents: Header text
setHeader
in interface IDialog
public java.lang.String getHeader()
Return the value of the header
property.
Contents: Header text
getHeader
in interface IDialog
public void setHeight(int height)
Set the value of the height
property.
Contents: Height of the element in pixels. Default (not specified or value <= 0) is auto. If auto, resizable should be false, or resizing may hehave erratically. If auto, IE7 may not size or position properly.
setHeight
in interface IDialog
public int getHeight()
Return the value of the height
property.
Contents: Height of the element in pixels. Default (not specified or value <= 0) is auto. If auto, resizable should be false, or resizing may hehave erratically. If auto, IE7 may not size or position properly. Default = 'Integer.MIN_VALUE'.
getHeight
in interface IDialog
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 IDialog
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 IDialog
public void setMinHeight(int minHeight)
Set the value of the minHeight
property.
Contents: Minimum height of resizable dialog
setMinHeight
in interface IDialog
public int getMinHeight()
Return the value of the minHeight
property.
Contents: Minimum height of resizable dialog Default = '0'.
getMinHeight
in interface IDialog
public void setMinWidth(int minWidth)
Set the value of the minWidth
property.
Contents: Minimum width of a resizable dialog
setMinWidth
in interface IDialog
public int getMinWidth()
Return the value of the minWidth
property.
Contents: Minimum width of a resizable dialog Default = '150'.
getMinWidth
in interface IDialog
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 IDialog
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 IDialog
public void setOnHide(java.lang.String onHide)
Set the value of the onHide
property.
Contents: Javascript code to be executed when hiding the dialog
setOnHide
in interface IDialog
public java.lang.String getOnHide()
Return the value of the onHide
property.
Contents: Javascript code to be executed when hiding the dialog
getOnHide
in interface IDialog
public void setOnShow(java.lang.String onShow)
Set the value of the onShow
property.
Contents: Javascript code to be executed when showing the dialog
setOnShow
in interface IDialog
public java.lang.String getOnShow()
Return the value of the onShow
property.
Contents: Javascript code to be executed when showing the dialog
getOnShow
in interface IDialog
public void setPosition(java.lang.String position)
Set the value of the position
property.
Contents: Specifies where the dialog should be displayed relative to the viewport. 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 IDialog
public java.lang.String getPosition()
Return the value of the position
property.
Contents: Specifies where the dialog should be displayed relative to the viewport. 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 IDialog
public void setRelativePosition(java.lang.String relativePosition)
Set the value of the relativePosition
property.
Contents: The side of the target component to position the dialog against. The format is "
setRelativePosition
in interface IDialog
public java.lang.String getRelativePosition()
Return the value of the relativePosition
property.
Contents: The side of the target component to position the dialog against. The format is "
getRelativePosition
in interface IDialog
public void setRelativeTo(java.lang.String relativeTo)
Set the value of the relativeTo
property.
Contents: Id of the component to position the dialog against. Setting this id will override the 'position' attribute, using 'dialogPosition' and 'relativePosition' instead.
setRelativeTo
in interface IDialog
public java.lang.String getRelativeTo()
Return the value of the relativeTo
property.
Contents: Id of the component to position the dialog against. Setting this id will override the 'position' attribute, using 'dialogPosition' and 'relativePosition' instead.
getRelativeTo
in interface IDialog
public void setResizable(boolean resizable)
Set the value of the resizable
property.
Contents: Makes the dialog resizable. Should be false if width or height is auto, or resizing may hehave erratically.
setResizable
in interface IDialog
public boolean isResizable()
Return the value of the resizable
property.
Contents: Makes the dialog resizable. Should be false if width or height is auto, or resizing may hehave erratically. Default = 'true'.
isResizable
in interface IDialog
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 IDialog
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 IDialog
public void setShowHeader(boolean showHeader)
Set the value of the showHeader
property.
Contents: Boolean value that specifies whether the dialog should have a header (default true)
setShowHeader
in interface IDialog
public boolean isShowHeader()
Return the value of the showHeader
property.
Contents: Boolean value that specifies whether the dialog should have a header (default true) Default = 'true'.
isShowHeader
in interface IDialog
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Style class of the main container of dialog
setStyleClass
in interface IDialog
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class of the main container of dialog
getStyleClass
in interface IDialog
public void setVisible(boolean visible)
Set the value of the visible
property.
Contents: visible can be used to toggle visibility on the server, rendered should not be used that way, setting rendered=false on a visible modal dialog will not remove the modality layer, visible=false must be set first (or client-side JS function called)
setVisible
in interface IDialog
public boolean isVisible()
Return the value of the visible
property.
Contents: visible can be used to toggle visibility on the server, rendered should not be used that way, setting rendered=false on a visible modal dialog will not remove the modality layer, visible=false must be set first (or client-side JS function called) Default = 'false'.
isVisible
in interface IDialog
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 IDialog
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 IDialog
public void setWidth(int width)
Set the value of the width
property.
Contents: Width of the element in pixels. Default (not specified or value <= 0) is auto. If auto, resizable should be false, or resizing may hehave erratically. If auto, IE7 may not size or position properly.
setWidth
in interface IDialog
public int getWidth()
Return the value of the width
property.
Contents: Width of the element in pixels. Default (not specified or value <= 0) is auto. If auto, resizable should be false, or resizing may hehave erratically. If auto, IE7 may not size or position properly. Default = 'Integer.MIN_VALUE'.
getWidth
in interface IDialog
public void setZindex(int zindex)
Set the value of the zindex
property.
Contents: zindex property to control overlapping with other elements
setZindex
in interface IDialog
public int getZindex()
Return the value of the zindex
property.
Contents: zindex property to control overlapping with other elements Default = '1000'.
getZindex
in interface IDialog
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
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 |