org.havi.ui.HSelectionInputPreferred Maven / Gradle / Ivy


package org.havi.ui;

/*
 * Copyright 2000-2003 by HAVi, Inc. Java is a trademark of Sun
 * Microsystems, Inc. All rights reserved.  
 */


/**
 * A component which implements  {@link org.havi.ui.HSelectionInputPreferred  HSelectionInputPreferred}  indicates that this component expects to receive  {@link org.havi.ui.event.HItemEvent  HItemEvent}  input events.  The system must provide a means of generating HItemEvent 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  {@link 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  {@link HComponent#setEnabled} ).   
 Widgets of HAVi compliant applications implementing the HSelectionInputPreferred 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.
 */

public interface HSelectionInputPreferred extends HOrientable
{
    /**
	 * Get the selection mode for this  {@link org.havi.ui.HSelectionInputPreferred  HSelectionInputPreferred} . If the returned value is true the component is in selection mode, and the selection may be changed.  
 The component is switched into and out of selection mode on receiving  {@link org.havi.ui.event.HItemEvent#ITEM_START_CHANGE  ITEM_START_CHANGE}  and  {@link org.havi.ui.event.HItemEvent#ITEM_END_CHANGE  ITEM_END_CHANGE}  events. Note that these events are ignored, if the component is disabled.
	 * @return  true if this component is in selection mode, false  otherwise.
	 * @see  HComponent#setEnabled
	 * @uml.property  name="selectionMode"
	 */
    public boolean getSelectionMode();

    /**
	 * Set the selection mode for this  {@link org.havi.ui.HSelectionInputPreferred  HSelectionInputPreferred} .  
 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.
	 * @param edit  true to switch this component into selection mode,  false otherwise.
	 * @see HComponent#setEnabled
	 * @see  HSelectionInputPreferred#getSelectionMode
	 * @uml.property  name="selectionMode"
	 */
    public void setSelectionMode(boolean edit);

    /**
     * Process an {@link org.havi.ui.event.HItemEvent
     * HItemEvent} sent to this {@link org.havi.ui.HSelectionInputPreferred
     * HSelectionInputPreferred}.
     * 
     * Widgets implementing this interface shall ignore
     * HItemEventa, while the component is disabled.
     * 
     * @param evt the {@link org.havi.ui.event.HItemEvent
     * HItemEvent} to process. 
     * @see HComponent#setEnabled
     */
    public void processHItemEvent(org.havi.ui.event.HItemEvent evt);
}