org.havi.ui.event.HRcCapabilities Maven / Gradle / Ivy

 
package org.havi.ui.event;

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

/**
   This class is used to describe the (basic) remote control
   capabilities of the platform.  This class is not intended to be
   constructed by applications.
   
  

  The parameters to the constructors are as follows, in cases where
  parameters are not used, then the constructor should use the default
  values.
  
  
Default parameter values exposed in the constructors
  
  Parameter Description Default value 
  Set method Get method
  None.
  
  Default parameter values not exposed in the constructors
  
  Description Default value Set method
  Get method
  None.
  

 */

public class HRcCapabilities 
    extends HKeyCapabilities
{
    /**
     * It is not intended that applications should directly construct
     * {@link org.havi.ui.event.HRcCapabilities HRcCapabilities}
     * objects.
     * 
     * Creates an {@link org.havi.ui.event.HRcCapabilities
     * HRcCapabilities} object. See the class description for details
     * of constructor parameters and default values.
     *  
     * This method is protected to allow the platform to override it
     * in a different package scope.  
     */
    protected HRcCapabilities()
    {
    }

    /**
     * Get the HEventRepresentation object for a
     * specified key event keyCode.
     * 
     * @param aCode the key event keyCode for which the 
     * HEventRepresentation should be returned. 
     * @return an HEventRepresentation
     * object for the specified key event keyCode, or
     * null if there is no valid representation available.
     */
    public static HEventRepresentation getRepresentation(int aCode)
    {
	return (null);
    }

    /**
     * Determine if a physical remote control exists in the system.  
     *
     * @return true if a physical remote control exists in the system,
     * false otherwise.
     * @see HKeyCapabilities#getInputDeviceSupported 
     */
    public static boolean getInputDeviceSupported()
    {
	return (true);
    }

    /**
     * Queries whether the remote control can directly generate an event
     * of the given type. Note that this method will return
     * false for key codes which can only be generated on this system
     * via a virtual keyboard.
     *
     * @param keycode the keycode to query e.g. VK_SPACE
     * @return true if events with the given key code can be directly
     * generated on this system via a physical remote control, false
     * otherwise.
     * @see HKeyCapabilities#isSupported
     */
    public static boolean isSupported(int keycode)
    {
        return (false);
    }

}