|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase javax.faces.component.UIPanel org.apache.myfaces.custom.dialog.AbstractModalDialog org.apache.myfaces.custom.dialog.ModalDialog
public class ModalDialog
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
DEFAULT_RENDERER_TYPE
|
Constructor Summary | |
---|---|
ModalDialog()
|
Method Summary | |
---|---|
java.lang.Boolean |
getCloseButton()
Specifies whether there should be a "close" icon to the right of the popup window title. |
java.lang.String |
getContentURL()
The URL to show within the content area of the dialog. |
java.lang.String |
getDialogAttr()
A space separated list with attribute='value' pairs, which control the behaviour of the dojo dialog. |
java.lang.String |
getDialogId()
An optional raw id to assign to the html div that encloses the modal dialog. |
java.lang.String |
getDialogTitle()
The title text to show in the title area of the popup window (ie the "window decoration"). |
java.lang.String |
getDialogVar()
Specifies the name of the javascript variable which provides access to the dialog functionality. |
java.lang.String |
getFamily()
|
java.lang.String |
getHiderIds()
A list of ids of components which, when activated, should cause the popup dialog to be hidden. |
java.lang.String |
getStyle()
HTML: CSS styling instructions. |
java.lang.String |
getStyleClass()
The CSS class for this element. |
java.lang.String |
getViewId()
The URL of the view to show within the content area of the dialog. |
java.lang.String |
getWidgetId()
Optional enforced dojo widgetId |
void |
restoreState(javax.faces.context.FacesContext facesContext,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext facesContext)
|
void |
setCloseButton(java.lang.Boolean closeButton)
|
void |
setContentURL(java.lang.String contentURL)
|
void |
setDialogAttr(java.lang.String dialogAttr)
|
void |
setDialogId(java.lang.String dialogId)
|
void |
setDialogTitle(java.lang.String dialogTitle)
|
void |
setDialogVar(java.lang.String dialogVar)
|
void |
setHiderIds(java.lang.String hiderIds)
|
void |
setStyle(java.lang.String style)
|
void |
setStyleClass(java.lang.String styleClass)
|
void |
setViewId(java.lang.String viewId)
|
void |
setWidgetId(java.lang.String widgetId)
|
Methods inherited from class org.apache.myfaces.custom.dialog.AbstractModalDialog |
---|
getRendersChildren, getWidgetVar, setWidgetVar |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
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_FAMILY
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String DEFAULT_RENDERER_TYPE
Constructor Detail |
---|
public ModalDialog()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIPanel
public java.lang.String getDialogAttr()
AbstractModalDialog
getDialogAttr
in class AbstractModalDialog
public void setDialogAttr(java.lang.String dialogAttr)
public java.lang.String getDialogId()
AbstractModalDialog
This id can be useful for controlling the dialog with javascript. However in most cases it is not necessary.
If this is property is not defined then an id will be automatically generated.
getDialogId
in class AbstractModalDialog
public void setDialogId(java.lang.String dialogId)
public java.lang.String getDialogVar()
AbstractModalDialog
For example, if this is "myDialog" then a javascript object with name "myDialog" will be defined. This exposes the following methods:
getDialogVar
in class AbstractModalDialog
public void setDialogVar(java.lang.String dialogVar)
setDialogVar
in class AbstractModalDialog
public java.lang.String getHiderIds()
AbstractModalDialog
If the standard title-bar is displayed (ie no custom titleBar facet exists, and property dialogTitle is defined) then the standard close-button in that bar is automatically included.
If the child components of this component (which will appear in the popup) include other items that should cause the window to close (ie a button) then their ids should be defined via this property. This component will then automatically wire them up to the necessary functions to cause the popup to be closed when they are activated.
getHiderIds
in class AbstractModalDialog
public void setHiderIds(java.lang.String hiderIds)
public java.lang.String getViewId()
AbstractModalDialog
Optional; when not defined (or defined as an EL expression, but that expression returns null) then the popup dialog will be opened with no content. Presumably custom javascript in the calling page will arrange to populate the window content appropriately.
The modalDialog component treats this as a url relative to the webapp base. The value should not start with a slash.
Note that technically this value is not a viewId. A viewId is the internal path to the page definition (eg "foo.jsp" or "foo.xhtml"). What the browser accesses is a URL (which contains the path that triggers the facelets servlet, eg "foo.faces" or "foo.jsf" or "/faces/foo".
The valueIt should not start with a slash.
getViewId
in class AbstractModalDialog
public void setViewId(java.lang.String viewId)
public java.lang.String getContentURL()
AbstractModalDialog
This may be:
getContentURL
in class AbstractModalDialog
public void setContentURL(java.lang.String contentURL)
public java.lang.String getStyle()
AbstractModalDialog
getStyle
in class AbstractModalDialog
public void setStyle(java.lang.String style)
public java.lang.String getStyleClass()
AbstractModalDialog
This value is also used as a base for defining style classes for parts of the standard window "title bar" decoration.
getStyleClass
in class AbstractModalDialog
public void setStyleClass(java.lang.String styleClass)
public java.lang.String getWidgetId()
AbstractModalDialog
getWidgetId
in interface org.apache.myfaces.custom.dojo.DojoWidget
getWidgetId
in class AbstractModalDialog
public void setWidgetId(java.lang.String widgetId)
public java.lang.String getDialogTitle()
AbstractModalDialog
Ignored if there is a "titleBar" facet as a child.
getDialogTitle
in class AbstractModalDialog
public void setDialogTitle(java.lang.String dialogTitle)
public java.lang.Boolean getCloseButton()
AbstractModalDialog
Ignored if there is a "titleBar" facet as a child, or dialogTitle is not defined.
Defaults to true.
getCloseButton
in class AbstractModalDialog
public void setCloseButton(java.lang.Boolean closeButton)
public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
public void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |