|
||||||||||
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.HStaticRange
org.havi.ui.HRange
org.havi.ui.HRangeValue
public class HRangeValue
The HRangeValue
is a user interface
component used to display a value within a fixed range (as
org.havi.ui.HStaticRange HStaticRange}) which enables a user to
navigate to and alter the value of it, i.e. it can have the input
focus and it can be adjusted. By default it uses the HRangeLook
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 |
orientation | The "orientation" of the range object. | ORIENT_LEFT_TO_RIGHT |
setOrientation |
getOrientation |
minimum | The minimum value that can be returned by this range object. | 0 | setRange |
getMinValue |
maximum | The maximum value that can be returned by this range object. | 100 | setRange |
getMaxValue |
value | The current value returned by this range object. | 0 | setValue |
getValue |
HStaticRange
,
HRange
,
HNavigable
,
HAdjustmentValue
,
Serialized FormField Summary |
---|
Fields inherited from class org.havi.ui.HStaticRange |
---|
SCROLLBAR_BEHAVIOR, SLIDER_BEHAVIOR |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface org.havi.ui.HOrientable |
---|
ORIENT_BOTTOM_TO_TOP, ORIENT_LEFT_TO_RIGHT, ORIENT_RIGHT_TO_LEFT, ORIENT_TOP_TO_BOTTOM |
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 | |
---|---|
HRangeValue()
Creates an HRangeValue
object. |
|
HRangeValue(int orientation,
int minimum,
int maximum,
int value)
Creates an HRangeValue
object. |
|
HRangeValue(int orientation,
int minimum,
int maximum,
int value,
int x,
int y,
int width,
int height)
Creates an HRangeValue
object. |
Method Summary | |
---|---|
void |
addAdjustmentListener(HAdjustmentListener l)
Adds the specified HAdjustmentListener to receive HAdjustmentEvents
sent from this object. |
void |
addHFocusListener(HFocusListener l)
Adds the specified HFocusListener to
receive HFocusEvent events sent from
this HNavigable : If the listener has
already been added further calls will add further references to the listener,
which will then receive multiple copies of a single event. |
HSound |
getAdjustmentSound()
Get the sound to be played when the value changes. |
boolean |
getAdjustMode()
Get the adjustment mode for this HRangeValue. |
int |
getBlockIncrement()
Get the block increment for this HRangeValue. |
static HRangeLook |
getDefaultLook()
Returns the currently set default look for HRangeValue components. |
HSound |
getGainFocusSound()
Get the sound associated with the gain focus event. |
HSound |
getLoseFocusSound()
Get the sound associated with the lost focus event. |
HNavigable |
getMove(int keyCode)
Provides the HNavigable object
that is navigated to when a particular key is pressed. |
int[] |
getNavigationKeys()
Retrieve the set of key codes which this component maps to navigation targets. |
int |
getUnitIncrement()
Get the unit increment for this HRangeValue. |
boolean |
isSelected()
Indicates if this component has focus. |
void |
processHAdjustmentEvent(HAdjustmentEvent evt)
Process an HAdjustmentEvent
sent to this HAdjustmentInputPreferred . |
void |
processHFocusEvent(HFocusEvent evt)
Process an HFocusEvent sent to this HRangeValue . |
void |
removeAdjustmentListener(HAdjustmentListener l)
Removes the specified HAdjustmentListener so that it no longer receives HAdjustmentEvents from
this object. |
void |
removeHFocusListener(HFocusListener l)
Removes the specified HFocusListener
so that it no longer receives HFocusEvent events from this HNavigable . |
void |
setAdjustmentSound(HSound sound)
Associate a sound to be played when the value is modified. |
void |
setAdjustMode(boolean adjust)
Set the adjustment mode for this HRangeValue. |
void |
setBlockIncrement(int increment)
Set the block increment for this HRangeValue. |
static void |
setDefaultLook(HRangeLook look)
Sets the default HLook for further
HRangeValue Components. |
void |
setFocusTraversal(HNavigable up,
HNavigable down,
HNavigable left,
HNavigable right)
Set the focus control for an HNavigable component. |
void |
setGainFocusSound(HSound sound)
Associate a sound with gaining focus, i.e. when the HNavigable receives a
HFocusEvent event of type
FOCUS_GAINED . |
void |
setLoseFocusSound(HSound sound)
Associate a sound with losing focus, i.e. when the HNavigable receives a
HFocusEvent event of type
FOCUS_LOST. |
void |
setMove(int keyCode,
HNavigable target)
Defines the navigation path from the current HNavigable to another HNavigable when a particular key is
pressed. |
void |
setUnitIncrement(int increment)
Set the unit increment for this HRangeValue. |
Methods inherited from class org.havi.ui.HStaticRange |
---|
getBehavior, getMaxValue, getMinValue, getOrientation, getThumbMaxOffset, getThumbMinOffset, getValue, setBehavior, setLook, setOrientation, setRange, setThumbOffsets, setValue |
Methods inherited from class org.havi.ui.HComponent |
---|
getMatte, isDoubleBuffered, isEnabled, processEvent, setMatte |
Methods inherited from class java.awt.Component |
---|
addComponentListener, addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disableEvents, dispatchEvent, doLayout, enableEvents, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getCursor, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getLocale, getLocation, getLocation, getLocationOnScreen, getName, getParent, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, hasFocus, imageUpdate, invalidate, isDisplayable, isLightweight, isShowing, isValid, isVisible, list, list, list, list, list, paintAll, paramString, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, removeComponentListener, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, repaint, repaint, repaint, repaint, requestFocus, setBackground, setBounds, setBounds, setCursor, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, toString, transferFocus, 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.HOrientable |
---|
getOrientation, setOrientation |
Constructor Detail |
---|
public HRangeValue()
HRangeValue
object. See the class description for details of constructor
parameters and default values.
public HRangeValue(int orientation, int minimum, int maximum, int value, int x, int y, int width, int height)
HRangeValue
object. See the class description for details of constructor
parameters and default values.
public HRangeValue(int orientation, int minimum, int maximum, int value)
HRangeValue
object. See the class description for details of constructor
parameters and default values.
Method Detail |
---|
public static void setDefaultLook(HRangeLook look)
HLook
for further
HRangeValue
Components.
look
- The HLook
that will be
used by default when creating a new HRangeValue
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 setLook
method.public static HRangeLook getDefaultLook()
HRangeValue
components.
HRangeValue
component.public void setMove(int keyCode, HNavigable target)
HNavigable
to another HNavigable
when a particular key is
pressed. Note that setFocusTraversal
is
equivalent to multiple calls to setMove
, where the key codes
VK_UP
, VK_DOWN
, VK_LEFT
,
VK_RIGHT
are used.
setMove
in interface HNavigable
setMove
in class HRange
keyCode
- The key code of the pressed key. Any numerical
keycode is allowed, but the platform may not be able to
generate all keycodes. Application authors should only use keys
for which HRcCapabilities.isSupported()
or
HKeyCapabilities.isSupported()
returns true.target
- The target HNavigable
object that should be navigated to. If a target is
to be removed from a particular navigation path, then
null
shall be specified.public HNavigable getMove(int keyCode)
HNavigable
object
that is navigated to when a particular key is pressed.
getMove
in interface HNavigable
getMove
in class HRange
keyCode
- The key code of the pressed key.
HNavigable
object or null
if no HNavigable
is associated with the keyCode.public void setFocusTraversal(HNavigable up, HNavigable down, HNavigable left, HNavigable right)
HNavigable
component. Note setFocusTraversal
is a
convenience function for application programmers where a standard
up, down, left and right focus traversal between components is
required.
Note setFocusTraversal
is equivalent to multiple calls to setMove
, where the key codes
VK_UP, VK_DOWN, VK_LEFT, VK_RIGHT are used.
Note that this
API does not prevent the creation of "isolated"
HNavigable
components --- authors
should endeavor to avoid confusing the user.
setFocusTraversal
in interface HNavigable
setFocusTraversal
in class HRange
up
- The HNavigable
component
to move to, when the user generates a VK_UP KeyEvent. If there is no HNavigable
component to move
"up" to, then null shall be specified.down
- The HNavigable
component to move to, when the user generates a VK_DOWN KeyEvent. If there
is no HNavigable
component to move
"down" to, then null shall be specified.left
- The HNavigable
component to move to, when the user generates a VK_LEFT KeyEvent. If there
is no HNavigable
component to move
"left" to, then null shall be specified.right
- The HNavigable
component to move to, when the user generates a VK_RIGHT KeyEvent. If there
is no HNavigable
component to move
"right" to, then null shall be specified.public boolean isSelected()
isSelected
in interface HNavigable
isSelected
in class HRange
true
if the component has focus, otherwise
returns false
.public void setGainFocusSound(HSound sound)
HNavigable
receives a
HFocusEvent
event of type
FOCUS_GAINED
. This sound will start to be played
when an object implementing this interface gains focus. It is
not guaranteed to be played to completion. If the object
implementing this interface loses focus before the audio
completes playing, the audio will be truncated. Applications
wishing to ensure the audio is always played to completion must
implement special logic to slow down the focus transitions.
By default, an HNavigable
object
does not have any gain focus sound associated with it.
Note that the ordering of playing sounds is dependent on the order of the focus lost, gained events.
setGainFocusSound
in interface HNavigable
setGainFocusSound
in class HRange
sound
- the sound to be played, when the component gains
focus. If sound content is already set, the original content is
replaced. To remove the sound specify a null HSound
.public void setLoseFocusSound(HSound sound)
HNavigable
receives a
HFocusEvent
event of type
FOCUS_LOST. This sound will start to be played when an object
implementing this interface loses focus. It is not guaranteed to be
played to completion. It is implementation dependent whether and when
this sound will be truncated by any gain focus sound played by the next
object to gain focus. By default, an HNavigable
object does not have any
lose focus sound associated with it.
Note that the ordering of playing sounds is dependent on the order of the focus lost, gained events.
setLoseFocusSound
in interface HNavigable
setLoseFocusSound
in class HRange
sound
- the sound to be played, when the component loses
focus. If sound content is already set, the original content is
replaced. To remove the sound specify a null HSound
.public HSound getGainFocusSound()
getGainFocusSound
in interface HNavigable
getGainFocusSound
in class HRange
public HSound getLoseFocusSound()
getLoseFocusSound
in interface HNavigable
getLoseFocusSound
in class HRange
public void addHFocusListener(HFocusListener l)
HFocusListener
to
receive HFocusEvent
events sent from
this HNavigable
: If the listener has
already been added further calls will add further references to the listener,
which will then receive multiple copies of a single event.
addHFocusListener
in interface HNavigable
addHFocusListener
in class HRange
l
- the HFocusListener to addpublic void removeHFocusListener(HFocusListener l)
HFocusListener
so that it no longer receives HFocusEvent
events from this HNavigable
. If
the specified listener is not registered, the method has no effect. If
multiple references to a single listener have been registered it should be
noted that this method will only remove one reference per call.
removeHFocusListener
in interface HNavigable
removeHFocusListener
in class HRange
l
- the HFocusListener to removepublic int[] getNavigationKeys()
getNavigationKeys
in interface HNavigationInputPreferred
getNavigationKeys
in class HRange
null
if no
navigation targets are set on this component.public void processHFocusEvent(HFocusEvent evt)
HFocusEvent
sent to this HRangeValue
.
processHFocusEvent
in interface HNavigationInputPreferred
processHFocusEvent
in class HRange
evt
- the HFocusEvent
to process.public void setUnitIncrement(int increment)
setUnitIncrement
in interface HAdjustmentValue
increment
- the amount by which the value of the
HRangeValue should change when an HAdjustmentEvent.ADJUST_LESS
or HAdjustmentEvent.ADJUST_MORE
event is
received. Values of increment
less than one shall
be treated as a value of one.public int getUnitIncrement()
1
shall be returned if this method is called
before its corresponding set method.
getUnitIncrement
in interface HAdjustmentValue
public void setBlockIncrement(int increment)
setBlockIncrement
in interface HAdjustmentValue
increment
- the amount by which the value of the
HRangeValue should change when an HAdjustmentEvent.ADJUST_PAGE_LESS
or HAdjustmentEvent.ADJUST_PAGE_MORE
event is received. Values of
increment
less than one shall be treated as a
value of one.public int getBlockIncrement()
1
shall be returned if this method is called before its
corresponding set method.
getBlockIncrement
in interface HAdjustmentValue
public void addAdjustmentListener(HAdjustmentListener l)
HAdjustmentEvents
sent from this object. If the listener has
already been added further calls will add further references to
the listener, which will then receive multiple copies of a
single event.
addAdjustmentListener
in interface HAdjustmentValue
l
- the HAdjustmentListener to be notified.public void removeAdjustmentListener(HAdjustmentListener l)
HAdjustmentEvents
from
this object. If the specified listener is not registered, the
method has no effect. If multiple references to
a single listener have been registered it should be noted that
this method will only remove one reference per call.
removeAdjustmentListener
in interface HAdjustmentValue
l
- the HAdjustmentListener to be removed from notification.public void setAdjustmentSound(HSound sound)
HAdjustmentEvent
is sent to one or more listeners.
setAdjustmentSound
in interface HAdjustmentValue
sound
- the sound to be played, when the value is
modified. If sound content is already set, the original content
is replaced. To remove the sound specify a null HSound
.public HSound getAdjustmentSound()
null
shall be returned if this method is called
before its corresponding set method.
getAdjustmentSound
in interface HAdjustmentValue
public boolean getAdjustMode()
true
the
component is in adjustment mode, and its value may be changed on
receipt of HAdjustmentEvent.ADJUST_LESS
and
HAdjustmentEvent.ADJUST_MORE
events.
The component is switched into and out of adjustment mode on
receiving HAdjustmentEvent.ADJUST_START_CHANGE
HAdjustmentEvent.ADJUST_END_CHANGE
events. Note that these events are ignored, if the component is
disabled.
getAdjustMode
in interface HAdjustmentInputPreferred
HComponent.setEnabled(boolean)
public void setAdjustMode(boolean adjust)
This method is provided for the convenience of component implementors. Interoperable applications shall not call this method. It cannot be made protected because interfaces cannot have protected methods.
Calls to this method shall be ignored, if the component is disabled.
setAdjustMode
in interface HAdjustmentInputPreferred
adjust
- true to switch this component into adjustment mode,
false otherwise.HAdjustmentInputPreferred.getAdjustMode()
,
HComponent.setEnabled(boolean)
public void processHAdjustmentEvent(HAdjustmentEvent evt)
HAdjustmentEvent
sent to this HAdjustmentInputPreferred
.
Widgets implementing this interface
shall ignore HAdjustmentEvents
, while the
component is disabled.
processHAdjustmentEvent
in interface HAdjustmentInputPreferred
evt
- the HAdjustmentEvent
to process.HComponent.setEnabled(boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |