org.gnu.gtk

Class ToggleButton

public class ToggleButton extends Button

A ToggleButton is a button that changes and retains its on or off state each time it is selected with the mouse. When in the on state, it will appear to be pressed in.

See Also: CheckButton RadioButton Button

Constructor Summary
ToggleButton()
Creates a new toggle button.
ToggleButton(Handle handle)
Construct a toggle button using a handle to a native resource.
ToggleButton(String label, boolean hasMnemonic)
Creates a new toggle button with a text label.
Method Summary
voidaddListener(ToggleListener listener)
Register an object to handle button events.
ClassgetEventListenerClass(String signal)
EventTypegetEventType(String signal)
booleangetInconsistent()
Return whether this is in the inconsistent state
booleangetState()
Returns the state of the toggle button
static ToggleButtongetToggleButton(Handle handle)
Internal static factory method to be used by Java-Gnome only.
static TypegetType()
Retrieve the runtime type used by the GLib library.
voidremoveListener(ToggleListener listener)
Removes a listener
voidsetInconsistent(boolean isInconsistent)
Determines whether the toggle button should be in the half-on, or inconsistent state.
voidsetState(boolean state)
Modifies the state of the toggle button

Constructor Detail

ToggleButton

public ToggleButton()
Creates a new toggle button.

ToggleButton

public ToggleButton(Handle handle)
Construct a toggle button using a handle to a native resource.

ToggleButton

public ToggleButton(String label, boolean hasMnemonic)
Creates a new toggle button with a text label. If the hasMnemonic Label is set, the button is assumes to contain mnemonic characters; that is characters which are preceeded by an underscore. These will appear underlined and will be used as keyboard accelerators.

Parameters: label The text to be displayed on the button hasMnemonic If true, keyboeard accelerators will be interpreted.

Method Detail

addListener

public void addListener(ToggleListener listener)
Register an object to handle button events.

See Also: ToggleListener

getEventListenerClass

public Class getEventListenerClass(String signal)

getEventType

public EventType getEventType(String signal)

getInconsistent

public boolean getInconsistent()
Return whether this is in the inconsistent state

Returns: True if the 'inbetween' state is in use

See Also: ToggleButton

getState

public boolean getState()
Returns the state of the toggle button

Returns: True if the button is on or 'pressed in'.

getToggleButton

public static ToggleButton getToggleButton(Handle handle)
Internal static factory method to be used by Java-Gnome only.

getType

public static Type getType()
Retrieve the runtime type used by the GLib library.

removeListener

public void removeListener(ToggleListener listener)
Removes a listener

See Also: addListener

setInconsistent

public void setInconsistent(boolean isInconsistent)
Determines whether the toggle button should be in the half-on, or inconsistent state. This is envirely a visual setting - changes to this will not affect the state of the button as returned by {@link #getState()}.

Parameters: isInconsistent If true, the button will appear in the in-between state.

setState

public void setState(boolean state)
Modifies the state of the toggle button

Parameters: state If true, the button is in the 'on', or 'pressed in' state.