|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Dialog
This interface represents the contents of a single Dialog within the system. (Dialogs are similar to Windows, but modal i.e. user has to dismiss the dialog before they do anything else. For this reason they should be used sparingly.)
Method Summary | |
---|---|
void |
close()
Closes the dialog. |
void |
setCloseable(boolean closeable)
Set whether the user can close the dialog by clicking the X button. |
void |
setContents(org.w3c.dom.Element e)
Clears existing contents and sets the contents of the dialog based on an XML document. |
void |
setContents(Widget w)
Clears existing contents and sets the contents of the dialog to a single widget. |
void |
setInitialSize(int width,
int height)
Set the dialog's initial size. |
void |
setMinSize(int minWidth,
int minHeight)
Set the minimum size for this dialog. |
void |
setOnClosed(java.lang.String callback)
Sets the action method called when dialog is closed. |
void |
setResizable(boolean resizable)
Set whether the user can resize the dialog. |
void |
setTitle(java.lang.String title)
Sets the dialog's title; used in title bar |
void |
show(WidgetOwner parent)
Call when the dialog is ready to show. |
Methods inherited from interface com.leafdigital.ui.api.WidgetOwner |
---|
getCallbackHandler, getGroupSelected, getWidget, isCreated, setWidgetID |
Method Detail |
---|
void setTitle(java.lang.String title)
title
- New title textvoid setInitialSize(int width, int height)
Calling this after the dialog has been shown has no effect. If you choose a size lower than the minimum, the minimum will be used.
width
- Initial widthheight
- Initial heightvoid setResizable(boolean resizable)
resizable
- True if user can resize windowvoid setCloseable(boolean closeable)
closeable
- True if user can close windowvoid setMinSize(int minWidth, int minHeight)
minWidth
- minHeight
- void show(WidgetOwner parent)
Unlike windows, your application is responsible for closing the dialog using close(). The user will not be able to access other windows until the dialog is hidden.
parent
- The dialog is positioned relative to this. Null is OK.void setContents(Widget w)
w
- Desired widgetvoid setContents(org.w3c.dom.Element e)
e
- XML element; must follow the appropriate format
BugException
- If there are format problems with the XMLvoid close()
After this call, the application will resume as normal.
@UICallback void setOnClosed(java.lang.String callback)
callback
- Name of method
BugException
- If method doesn't exist etc.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |