org.gnu.gtk
public class Dialog extends Window
Deprecated: This class is part of the java-gnome 2.x family of libraries,
which, due to their inefficiency and complexity, are no longer
being maintained and have been abandoned by the java-gnome
project. This class may in the future have an equivalent in
java-gnome 4.0, try looking for
org.gnome.gtk.Dialog
.
You should be aware that there is a considerably different API
in the new library: the architecture is completely different
and most notably internals are no longer exposed to public view.
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. |
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Construct a new Dialog objectDeprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Construct a dialog using a handle to a native resource.Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Adds a button with the given text and sets things up so that clicking the button will emit the "response" event with the givenresponseId
.
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.
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Adds a button with the given stock button and sets things up so that clicking the button will emit the "response" event with the givenresponseId
.
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.
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Register an object to handle dialog events.See Also: DialogListener
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
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. The Widget is appended to the end of the Dialog's action area.Parameters: child An activatable Widget to add to the dialog. responseId The response ID to emit when the user clicks the widget.
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
The lower area of the Dialog where the buttons are located is a HButtonBox. This method will return that container.Returns: The HButton box that is known as the action area.
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Internal static factory method to be used by Java-Gnome only.Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
The upper area of the Dialog where widgets can be added is a VBox. This method will return that layout control.Returns: The VBox that is the layout control for the dialog.
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Access for whether the dialog has a separator.Returns: true if the Dialog has a separator.
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Gets the response id of a widget in the action area of a dialog.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.
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Retrieve the runtime type used by the GLib library.Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Removes a listenerSee Also: addListener
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Blocks in a recursive main loop until the dialog either emits a response signal or is destroyed. The return value can be compared against a ResponseType to determine if a standard return value is emitted. The developer can also set the response type when a button or widget is added to the dialog. If the dialog is destroyed the run method will return NONE.Returns: The response that indicates which button the user pressed or NONE if the window was destroyed.
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets the last widget in the dialog's action area with the given responseId as the default widget for the dialog. Pressing "Enter" normally activates the default widget.Parameters: responseId The response ID.
Deprecated: Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Sets whether the dialog has a separator above the buttons. This is true by default.Parameters: setting Indicates if a separator should be added to the dialog.