org.gnu.gtk
Class ToggleButton

java.lang.Object
  |
  +--org.gnu.glib.GObject
        |
        +--org.gnu.gtk.GtkObject
              |
              +--org.gnu.gtk.Widget
                    |
                    +--org.gnu.gtk.Container
                          |
                          +--org.gnu.gtk.Bin
                                |
                                +--org.gnu.gtk.Button
                                      |
                                      +--org.gnu.gtk.ToggleButton
Direct Known Subclasses:
CheckButton

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(int handle)
          Construct a toggle button using a handle to a native resource.
ToggleButton(java.lang.String label, boolean hasMnemonic)
          Creates a new toggle button with a text label.
 
Method Summary
 void addListener(ToggleListener listener)
          Register an object to handle button events.
 java.lang.Class getEventListenerClass(java.lang.String signal)
           
 GtkEventType getEventType(java.lang.String signal)
           
 boolean getInconsistent()
          Return whether this is in the inconsistent state
 boolean getState()
          Returns the state of the toggle button
static Type getType()
          Retrieve the runtime type used by the GLib library.
 void removeListener(ToggleListener listener)
          Removes a listener
 void setInconsistent(boolean isInconsistent)
          Determines whether the toggle button should be in the half-on, or inconsistent state.
 void setState(boolean state)
          Modifies the state of the toggle button
 
Methods inherited from class org.gnu.gtk.Button
addListener, click, enter, getLabel, getRelief, getUseStock, getUseUnderline, leave, press, release, removeListener, setLabel, setRelief, setUseStock, setUseUnderline
 
Methods inherited from class org.gnu.gtk.Bin
getChild
 
Methods inherited from class org.gnu.gtk.Container
add, addListener, getBorderWidth, getResizeMode, remove, removeListener, resizeChildren, setBorderWidth, setResizeMode
 
Methods inherited from class org.gnu.gtk.Widget
activate, addListener, addListener, addListener, addListener, addListener, addListener, createContext, createLayout, destroy, draw, drawArea, drawArea, getAccessible, getColormap, getContext, getModifierStyle, getName, getParent, getParentWindow, getPointer, getSensitive, getStyle, getToplevel, grabDefault, grabFocus, hasFocus, hide, hideAll, intersect, isAncestor, makeWidget, modifyStyle, popColormap, pushColormap, realize, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, reparent, setBackgroundColor, setBaseColor, setColormap, setDoubleBuffered, setDragDestination, setDragSource, setFont, setForegroundColor, setMinimumSize, setName, setNoDragDestination, setNoDragSource, setSensitive, setTextColor, shapeCombineMask, show, showAll
 
Methods inherited from class org.gnu.glib.GObject
addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, addEventHandler, equals, getData, getHandle, removeEventHandler, setData
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ToggleButton

public ToggleButton()
Creates a new toggle button.


ToggleButton

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


ToggleButton

public ToggleButton(java.lang.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

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.

getState

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

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

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 getState().

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

getInconsistent

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

Returns:
True if the 'inbetween' state is in use
See Also:
setInconsistent(boolean)

addListener

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

See Also:
ToggleListener

removeListener

public void removeListener(ToggleListener listener)
Removes a listener

See Also:
addListener(ToggleListener)

getEventListenerClass

public java.lang.Class getEventListenerClass(java.lang.String signal)
Overrides:
getEventListenerClass in class Button

getEventType

public GtkEventType getEventType(java.lang.String signal)
Overrides:
getEventType in class Button

getType

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


Please send any bug reports, comments, or suggestions for the API or documentation to java-gnome-developer@lists.sf.net