|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
org.havi.ui.HComponent
org.havi.ui.HVisible
org.havi.ui.HStaticIcon
org.havi.ui.HIcon
org.havi.ui.HGraphicButton
org.havi.ui.HToggleButton
The HToggleButton
is a user interface
component representing a "check box", or with the support
of the HToggleGroup
class,
"radio buttons". It displays static read-only graphical
content. This component can be navigated to, i.e. it can have the
input focus, and it can be actioned as defined by the HSwitchable
interface. This means that the
interaction state persists after HActionEvent
event processing is
complete.
The current switchable state can be manipulated using setSwitchableState(boolean)
and getSwitchableState()
By default it uses the HGraphicLook
class to
render itself.
Parameter | Description | Default value | Set method | Get method |
---|---|---|---|---|
x | x-coordinate of top left hand corner of this component in pixels, relative to its parent container (subject to layout management). | --- | java.awt.Component#setBounds | java.awt.Component#getBounds |
y | y-coordinate of top left hand corner of this component in pixels, relative to its parent container (subject to layout management). | --- | java.awt.Component#setBounds | java.awt.Component#getBounds |
width | width of this component in pixels (subject to layout management). | --- | java.awt.Component#setBounds | java.awt.Component#getBounds |
height | height of this component in pixels (subject to layout management). | --- | java.awt.Component#setBounds | java.awt.Component#getBounds |
image | The image to be used as the content for every state of this component. | null | setGraphicContent |
getGraphicContent |
imageNormal | The image to be used as the content for the HState.NORMAL_STATE state of
this component. |
null | setGraphicContent |
getGraphicContent |
imageFocused | The image to be used as the content for the
HState.FOCUSED_STATE and
HState.DISABLED_FOCUSED_STATE states of this component. |
null | setGraphicContent |
getGraphicContent |
imageActioned | The image to be used as the content for the
HState.ACTIONED_FOCUSED_STATE and
HState.DISABLED_ACTIONED_FOCUSED_STATE states of this
component. |
null | setGraphicContent |
getGraphicContent |
imageNormalActioned | The image to be used as the content for the
HState.ACTIONED_STATE and
HState.DISABLED_ACTIONED_STATE states of this component. |
null | setGraphicContent |
getGraphicContent |
state | The switchable state of this HToggleButton . |
false | setSwitchableState(boolean) |
getSwitchableState() |
group | The HToggleGroup with which to
associate this HToggleButton . |
null | setToggleGroup(org.havi.ui.HToggleGroup) |
getToggleGroup() |
HStaticIcon
,
HIcon
,
HNavigable
,
HActionable
,
HSwitchable
,
Serialized FormField Summary |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface org.havi.ui.HState |
ACTIONED_FOCUSED_STATE, ACTIONED_STATE, ACTIONED_STATE_BIT, ALL_STATES, DISABLED_ACTIONED_FOCUSED_STATE, DISABLED_ACTIONED_STATE, DISABLED_FOCUSED_STATE, DISABLED_STATE, DISABLED_STATE_BIT, FIRST_STATE, FOCUSED_STATE, FOCUSED_STATE_BIT, LAST_STATE, NORMAL_STATE |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
HToggleButton()
Creates an HToggleButton
object. |
|
HToggleButton(java.awt.Image image)
Creates an HToggleButton
object. |
|
HToggleButton(java.awt.Image image,
boolean state,
HToggleGroup group)
Creates an HToggleButton
object. |
|
HToggleButton(java.awt.Image imageNormal,
java.awt.Image imageFocused,
java.awt.Image imageActioned,
java.awt.Image imageNormalActioned,
boolean state)
Creates an HToggleButton
object. |
|
HToggleButton(java.awt.Image imageNormal,
java.awt.Image imageFocused,
java.awt.Image imageActioned,
java.awt.Image imageNormalActioned,
boolean state,
HToggleGroup group)
Creates an HToggleButton
object. |
|
HToggleButton(java.awt.Image imageNormal,
java.awt.Image imageFocused,
java.awt.Image imageActioned,
java.awt.Image imageNormalActioned,
int x,
int y,
int width,
int height,
boolean state)
Creates an HToggleButton
object. |
|
HToggleButton(java.awt.Image imageNormal,
java.awt.Image imageFocused,
java.awt.Image imageActioned,
java.awt.Image imageNormalActioned,
int x,
int y,
int width,
int height,
boolean state,
HToggleGroup group)
Creates an HToggleButton
object. |
|
HToggleButton(java.awt.Image image,
int x,
int y,
int width,
int height)
Creates an HToggleButton
object. |
|
HToggleButton(java.awt.Image image,
int x,
int y,
int width,
int height,
boolean state)
Creates an HToggleButton
object. |
|
HToggleButton(java.awt.Image image,
int x,
int y,
int width,
int height,
boolean state,
HToggleGroup group)
Creates an HToggleButton
object. |
Method Summary | |
static HGraphicLook |
getDefaultLook()
Returns the currently set default HLook
for HToggleButton
components. |
boolean |
getSwitchableState()
Returns the current switchable state of this HSwitchable . |
HToggleGroup |
getToggleGroup()
Gets the HToggleGroup the
HToggleButton is associated
with. |
HSound |
getUnsetActionSound()
Get the sound to be played when the interaction state of the HSwitchable makes the
following transitions:
ACTIONED_STATE to NORMAL_STATE
ACTIONED_FOCUSED_STATE to FOCUSED_STATE
|
void |
removeToggleGroup()
Removes the button from the toggle group that it has been added to. |
static void |
setDefaultLook(HGraphicLook hlook)
Sets the default HLook for further HToggleButton components. |
void |
setSwitchableState(boolean state)
Sets the current state of the button. |
void |
setToggleGroup(HToggleGroup group)
Associates the HToggleButton
with an HToggleGroup . |
void |
setUnsetActionSound(HSound sound)
Associate a sound to be played when the interaction state of the HSwitchable makes the
following transitions:
ACTIONED_STATE to NORMAL_STATE
ACTIONED_FOCUSED_STATE to FOCUSED_STATE
|
Methods inherited from class org.havi.ui.HStaticIcon |
setLook |
Methods inherited from class org.havi.ui.HComponent |
getMatte, isDoubleBuffered, isEnabled, processEvent, setMatte |
Methods inherited from class java.awt.Component |
addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, areFocusTraversalKeysSet, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, doLayout, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getCursor, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, hasFocus, imageUpdate, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusCycleRoot, isFocusOwner, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, list, list, list, list, list, paintAll, paramString, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, setBackground, setBounds, setBounds, setCursor, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.havi.ui.HActionable |
addHActionListener, getActionSound, removeHActionListener, setActionCommand, setActionSound |
Methods inherited from interface org.havi.ui.HNavigable |
addHFocusListener, getGainFocusSound, getLoseFocusSound, getMove, isSelected, removeHFocusListener, setFocusTraversal, setGainFocusSound, setLoseFocusSound, setMove |
Methods inherited from interface org.havi.ui.HNavigationInputPreferred |
getNavigationKeys, processHFocusEvent |
Methods inherited from interface org.havi.ui.HActionInputPreferred |
getActionCommand, processHActionEvent |
Constructor Detail |
public HToggleButton()
HToggleButton
object. See the class description for details of constructor
parameters and default values.
public HToggleButton(java.awt.Image image, int x, int y, int width, int height)
HToggleButton
object. See the class description for details of constructor
parameters and default values.
public HToggleButton(java.awt.Image image)
HToggleButton
object. See the class description for details of constructor
parameters and default values.
public HToggleButton(java.awt.Image image, int x, int y, int width, int height, boolean state)
HToggleButton
object. See the class description for details of constructor
parameters and default values.
public HToggleButton(java.awt.Image imageNormal, java.awt.Image imageFocused, java.awt.Image imageActioned, java.awt.Image imageNormalActioned, int x, int y, int width, int height, boolean state)
HToggleButton
object. See the class description for details of constructor
parameters and default values.
public HToggleButton(java.awt.Image imageNormal, java.awt.Image imageFocused, java.awt.Image imageActioned, java.awt.Image imageNormalActioned, boolean state)
HToggleButton
object. See the class description for details of constructor
parameters and default values.
public HToggleButton(java.awt.Image image, int x, int y, int width, int height, boolean state, HToggleGroup group)
HToggleButton
object. See the class description for details of constructor
parameters and default values.
public HToggleButton(java.awt.Image image, boolean state, HToggleGroup group)
HToggleButton
object. See the class description for details of constructor
parameters and default values.
public HToggleButton(java.awt.Image imageNormal, java.awt.Image imageFocused, java.awt.Image imageActioned, java.awt.Image imageNormalActioned, int x, int y, int width, int height, boolean state, HToggleGroup group)
HToggleButton
object. See the class description for details of constructor
parameters and default values.
public HToggleButton(java.awt.Image imageNormal, java.awt.Image imageFocused, java.awt.Image imageActioned, java.awt.Image imageNormalActioned, boolean state, HToggleGroup group)
HToggleButton
object. See the class description for details of constructor
parameters and default values.
Method Detail |
public void setToggleGroup(HToggleGroup group)
HToggleButton
with an HToggleGroup
. If this
HToggleButton
is already in a
different HToggleGroup
, it is
first taken out of that group.
group
- The HToggleGroup
the HToggleButton
is to be
associated with.public HToggleGroup getToggleGroup()
HToggleGroup
the
HToggleButton
is associated
with.
HToggleGroup
the
HToggleButton
is associated
with, or null if the HToggleButton
is not associated with an HToggleGroup
.public void removeToggleGroup()
HToggleGroup
.
public static void setDefaultLook(HGraphicLook hlook)
HLook
for further HToggleButton
components.
hlook
- The HLook
that will be
used by default when creating a new HToggleButton
component.
Note that this parameter may be null, in which case newly
created components shall not draw themselves until a non-null
look is set using the HStaticIcon.setLook(org.havi.ui.HLook)
method.public static HGraphicLook getDefaultLook()
HLook
for HToggleButton
components.
HLook
that is used by
default when creating a new HToggleButton
component.public boolean getSwitchableState()
HSwitchable
.
getSwitchableState
in interface HSwitchable
HSwitchable
.public void setSwitchableState(boolean state)
processActionEvent
,
they are not called by setSwitchableState
.
setSwitchableState
in interface HSwitchable
public void setUnsetActionSound(HSound sound)
HSwitchable
makes the
following transitions:
setUnsetActionSound
in interface HSwitchable
sound
- a sound to be played when the HSwitchable
transitions from an
actioned state. If sound content is already set, the original
content is replaced. To remove the sound specify a null HSound
.public HSound getUnsetActionSound()
HSwitchable
makes the
following transitions:
getUnsetActionSound
in interface HSwitchable
HSwitchable
transitions from an
actioned state.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |