org.havi.ui

Interface HAdjustmentInputPreferred

All Superinterfaces:

HOrientable

All Known Subinterfaces:

HAdjustmentValue

All Known Implementing Classes:

HRangeValue

public interface HAdjustmentInputPreferred
extends HOrientable

A component which implements HAdjustmentInputPreferred indicates that this component expects to receive HAdjustmentEvent input events.

The system must provide a means of generating HAdjustmentEvent events as necessary. For platforms with a restricted number of physical keys this may involve a "virtual keyboard" or similar mechanism. The system might use the information returned by the method HOrientable.getOrientation() of the super interface to select appropriate key mappings for this event. The mechanisms to generate this event shall not be effective while the component is disabled (see HComponent.setEnabled(boolean) ).

Widgets of HAVi compliant applications implementing the HAdjustmentInputPreferred interface must have HComponent in their inheritance tree.

Note that the java.awt.Component method isFocusTraversable shall always return true for a java.awt.Component implementing this interface.

Field Summary

Fields inherited from interface org.havi.ui.HOrientable

ORIENT_BOTTOM_TO_TOP, ORIENT_LEFT_TO_RIGHT, ORIENT_RIGHT_TO_LEFT, ORIENT_TOP_TO_BOTTOM

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAdjustMode() Get the adjustment mode for this HAdjustmentInputPreferred.
void	processHAdjustmentEvent(HAdjustmentEvent evt) Process an HAdjustmentEvent sent to this HAdjustmentInputPreferred.
void	setAdjustMode(boolean adjust) Set the adjustment mode for this HAdjustmentInputPreferred.

Methods inherited from interface org.havi.ui.HOrientable

getOrientation, setOrientation

Method Detail

getAdjustMode

boolean getAdjustMode()

Get the adjustment mode for this HAdjustmentInputPreferred. If the returned value is 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.

Returns:

true if this component is in adjustment mode, false otherwise.

See Also:

HComponent.setEnabled(boolean)

setAdjustMode

void setAdjustMode(boolean adjust)

Set the adjustment mode for this HAdjustmentInputPreferred.

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.

Parameters:

adjust - true to switch this component into adjustment mode, false otherwise.

See Also:

getAdjustMode(), HComponent.setEnabled(boolean)

processHAdjustmentEvent

void processHAdjustmentEvent(HAdjustmentEvent evt)

Process an HAdjustmentEvent sent to this HAdjustmentInputPreferred. Widgets implementing this interface shall ignore HAdjustmentEvents, while the component is disabled.

Parameters:

evt - the HAdjustmentEvent to process.

See Also:

HComponent.setEnabled(boolean)