org.gnu.gtk
public class Dialog extends Window
GTK+ treats a dialog as a window split vertically. The top section is a VBox, and is where widgets such as a Label or a Entry should be packed. The bottom area is known as the actionArea. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two areas are separated by a HSeparator.
A 'modal' dialog (that is, one which freezes the rest of the application from user input), can be created by calling Window on the dialog.
If you want to block waiting for a dialog to return before returning control flow to your code, you can call run. This function enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked.
Constructor Summary | |
---|---|
Dialog()
Construct a new Dialog object | |
Dialog(Handle handle)
Construct a dialog using a handle to a native resource. |
Method Summary | |
---|---|
void | addButton(String buttonText, int responseId)
Adds a button with the given text and sets things up so that clicking the
button will emit the "response" event with the given
responseId .
|
void | addButton(GtkStockItem stockItem, int responseId)
Adds a button with the given stock button and sets things up so that
clicking the button will emit the "response" event with the given
responseId .
|
void | addListener(DialogListener listener)
Register an object to handle dialog events.
|
void | addWidget(Widget child, int responseId)
Adds an activatable widget to the action area of the Dialog, connecting a
signal handler that will emit the "response" signal on the dialog when
the widget is activated. |
HButtonBox | getActionArea()
The lower area of the Dialog where the buttons are located is a
HButtonBox. |
static Dialog | getDialog(Handle handle)
Internal static factory method to be used by Java-Gnome only. |
VBox | getDialogLayout()
The upper area of the Dialog where widgets can be added is a VBox. |
Class | getEventListenerClass(String signal) |
EventType | getEventType(String signal) |
boolean | getHasSeparator()
Access for whether the dialog has a separator.
|
ResponseType | getResponseForWidget(Widget widget)
Gets the response id of a widget in the action area of a dialog.
|
static Type | getType()
Retrieve the runtime type used by the GLib library. |
void | removeListener(DialogListener listener)
Removes a listener
|
int | run()
Blocks in a recursive main loop until the dialog either emits a
response signal or is destroyed. |
void | setDefaultResponse(int responseId)
Sets the last widget in the dialog's action area with the given
responseId as the default widget for the dialog. |
void | setHasSeparator(boolean setting)
Sets whether the dialog has a separator above the buttons. |
responseId
.
Parameters: buttonText The text string to display on the button. responseId The response ID to emit when the user clicks the button that is to be added.
responseId
.
Parameters: stockItem The stock ID for the button to be added. responseId The response ID to emit when the user clicks the button that is to be added.
See Also: DialogListener
Parameters: child An activatable Widget to add to the dialog. responseId The response ID to emit when the user clicks the widget.
Returns: The HButton box that is known as the action area.
Returns: The VBox that is the layout control for the dialog.
Returns: true if the Dialog has a separator.
Parameters: widget a widget in the action area of this Dialog.
Returns: the response id of the widget, or ResponseType.NONE if the widget doesn't have a response id set.
See Also: addListener
Returns: The response that indicates which button the user pressed or NONE if the window was destroyed.
Parameters: responseId The response ID.
Parameters: setting Indicates if a separator should be added to the dialog.