org.havi.ui.HGraphicButton Maven / Gradle / Ivy
package org.havi.ui;
/*
* Copyright 2000-2003 by HAVi, Inc. Java is a trademark of Sun
* Microsystems, Inc. All rights reserved.
*/
import java.awt.Image;
/**
The {@link org.havi.ui.HGraphicButton HGraphicButton} is a user interface
component representing a push-button with static read-only graphical
content. This component can be navigated to, i.e. it can have the input
focus, and it can also be actioned as defined by the {@link
org.havi.ui.HActionable HActionable} interface.
By default it uses the {@link org.havi.ui.HGraphicLook HGraphicLook} class to
render itself.
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
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
{@link org.havi.ui.HVisible#setGraphicContent setGraphicContent}
{@link org.havi.ui.HVisible#getGraphicContent getGraphicContent}
imageNormal
The image to be used as the content for the {@link
org.havi.ui.HState#NORMAL_STATE HState.NORMAL_STATE} state of
this component.
null
{@link org.havi.ui.HVisible#setGraphicContent setGraphicContent}
{@link org.havi.ui.HVisible#getGraphicContent getGraphicContent}
imageFocused
The image to be used as the content for the
{@link HState#FOCUSED_STATE} and
{@link HState#DISABLED_FOCUSED_STATE} states of this component.
null
{@link org.havi.ui.HVisible#setGraphicContent setGraphicContent}
{@link org.havi.ui.HVisible#getGraphicContent getGraphicContent}
imageActioned
The image to be used as the content for the
{@link HState#ACTIONED_STATE} and
{@link HState#ACTIONED_FOCUSED_STATE} states of this component.
null
{@link org.havi.ui.HVisible#setGraphicContent setGraphicContent}
{@link org.havi.ui.HVisible#getGraphicContent getGraphicContent}
Default parameter values not exposed in the constructors
Description Default value Set method
Get method
Associated matte ({@link org.havi.ui.HMatte HMatte}).
none (i.e. getMatte() returns null)
{@link org.havi.ui.HComponent#setMatte setMatte}
{@link org.havi.ui.HComponent#getMatte getMatte}
The text layout manager responsible for text
formatting.
An {@link org.havi.ui.HDefaultTextLayoutManager}
object.
{@link org.havi.ui.HVisible#setTextLayoutManager}
{@link org.havi.ui.HVisible#getTextLayoutManager}
The background painting mode
{@link org.havi.ui.HVisible#NO_BACKGROUND_FILL}
{@link org.havi.ui.HVisible#setBackgroundMode}
{@link org.havi.ui.HVisible#getBackgroundMode}
The default preferred size
not set (i.e. NO_DEFAULT_SIZE) unless specified by width
and height parameters
{@link org.havi.ui.HVisible#setDefaultSize}
{@link org.havi.ui.HVisible#getDefaultSize}
The horizontal content alignment
{@link org.havi.ui.HVisible#HALIGN_CENTER}
{@link org.havi.ui.HVisible#setHorizontalAlignment}
{@link org.havi.ui.HVisible#getHorizontalAlignment}
The vertical content alignment
{@link org.havi.ui.HVisible#VALIGN_CENTER}
{@link org.havi.ui.HVisible#setVerticalAlignment}
{@link org.havi.ui.HVisible#getVerticalAlignment}
The content scaling mode
{@link org.havi.ui.HVisible#RESIZE_NONE}
{@link org.havi.ui.HVisible#setResizeMode}
{@link org.havi.ui.HVisible#getResizeMode}
The border mode
true{@link org.havi.ui.HVisible#setBordersEnabled}
{@link org.havi.ui.HVisible#getBordersEnabled}
The default "look" for this class.
A platform specific {@link org.havi.ui.HGraphicLook HGraphicLook}
{@link org.havi.ui.HGraphicButton#setDefaultLook HGraphicButton.setDefaultLook}
{@link org.havi.ui.HGraphicButton#getDefaultLook HGraphicButton.getDefaultLook}
The "look" for this object.
The {@link org.havi.ui.HGraphicLook HGraphicLook} returned from
HGraphicButton.getDefaultLook when this object was created.
{@link org.havi.ui.HGraphicButton#setLook HGraphicButton.setLook}
{@link org.havi.ui.HGraphicButton#getLook HGraphicButton.getLook}
The gain focus sound.
null
{@link org.havi.ui.HGraphicButton#setGainFocusSound setGainFocusSound}
{@link org.havi.ui.HGraphicButton#getGainFocusSound getGainFocusSound}
The lose focus sound.
null
{@link org.havi.ui.HGraphicButton#setLoseFocusSound setLoseFocusSound}
{@link org.havi.ui.HGraphicButton#getLoseFocusSound getLoseFocusSound}
The action sound.
null
{@link org.havi.ui.HGraphicButton#setActionSound setActionSound}
{@link org.havi.ui.HGraphicButton#getActionSound getActionSound}
@see HStaticIcon
@see HIcon
@see HNavigable
@see HActionable
*/
public class HGraphicButton
extends HIcon
implements HActionable
{
/**
* Creates an {@link org.havi.ui.HGraphicButton HGraphicButton}
* object. See the class description for details of constructor
* parameters and default values. For constructors which specify
* content as parameters, see 'State-based content' in HVisible
* for unspecified content associated with other HStates.
*/
public HGraphicButton()
{
}
/**
* Creates an {@link org.havi.ui.HGraphicButton HGraphicButton}
* object. See the class description for details of constructor
* parameters and default values. For constructors which specify
* content as parameters, see 'State-based content' in HVisible
* for unspecified content associated with other HStates.
*/
public HGraphicButton(Image image, int x, int y, int width, int height)
{
}
/**
* Creates an {@link org.havi.ui.HGraphicButton HGraphicButton}
* object. See the class description for details of constructor
* parameters and default values. For constructors which specify
* content as parameters, see 'State-based content' in HVisible
* for unspecified content associated with other HStates.
*/
public HGraphicButton(Image imageNormal, Image imageFocused,
Image imageActioned, int x, int y, int width,
int height)
{
}
/**
* Creates an {@link org.havi.ui.HGraphicButton HGraphicButton}
* object. See the class description for details of constructor
* parameters and default values. For constructors which specify
* content as parameters, see 'State-based content' in HVisible
* for unspecified content associated with other HStates.
*/
public HGraphicButton(Image image)
{
}
/**
* Creates an {@link org.havi.ui.HGraphicButton HGraphicButton}
* object. See the class description for details of constructor
* parameters and default values. For constructors which specify
* content as parameters, see 'State-based content' in HVisible
* for unspecified content associated with other HStates.
*/
public HGraphicButton(Image imageNormal, Image imageFocused,
Image imageActioned)
{
}
/**
* Sets the default {@link org.havi.ui.HLook HLook} for further
* {@link org.havi.ui.HGraphicButton HGraphicButton} components.
*
* @param hlook The {@link org.havi.ui.HLook HLook} that will be
* used by default when creating a new {@link
* org.havi.ui.HGraphicButton HGraphicButton} 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 {@link
* org.havi.ui.HStaticIcon#setLook setLook} method.
*/
public static void setDefaultLook(HGraphicLook hlook)
{
}
/**
* Returns the currently set default {@link org.havi.ui.HLook
* HLook} for {@link org.havi.ui.HGraphicButton HGraphicButton}
* components.
*
* @return The {@link org.havi.ui.HLook HLook} that is used by
* default when creating a new {@link org.havi.ui.HGraphicButton
* HGraphicButton}.
*/
public static HGraphicLook getDefaultLook()
{
return (null);
}
/**
* Defines the navigation path from the current {@link
* org.havi.ui.HNavigable HNavigable} to another {@link
* org.havi.ui.HNavigable HNavigable} when a particular key is
* pressed. Note that {@link
* org.havi.ui.HNavigable#setFocusTraversal setFocusTraversal} is
* equivalent to multiple calls to {@link
* org.havi.ui.HNavigable#setMove setMove}, where the key codes
* VK_UP, VK_DOWN, VK_LEFT,
* VK_RIGHT are used.
*
* @param 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.
* @param target The target {@link org.havi.ui.HNavigable
* 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 void setMove(int keyCode, HNavigable target)
{
return;
}
/**
* Provides the {@link org.havi.ui.HNavigable HNavigable} object
* that is navigated to when a particular key is pressed.
*
* @param keyCode The key code of the pressed key.
* @return Returns the {@link org.havi.ui.HNavigable HNavigable}
* object or null if no {@link org.havi.ui.HNavigable
* HNavigable} is associated with the keyCode.
*/
public HNavigable getMove(int keyCode)
{
return(null);
}
/**
* Set the focus control for an {@link org.havi.ui.HNavigable
* HNavigable} component. Note {@link
* org.havi.ui.HNavigable#setFocusTraversal setFocusTraversal} is a
* convenience function for application programmers where a standard
* up, down, left and right focus traversal between components is
* required.
*
* Note {@link org.havi.ui.HNavigable#setFocusTraversal
* setFocusTraversal} is equivalent to multiple calls to {@link
* org.havi.ui.HNavigable#setMove 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"
* {@link org.havi.ui.HNavigable HNavigable} components --- authors
* should endeavor to avoid confusing the user.
*
* @param up The {@link org.havi.ui.HNavigable HNavigable} component
* to move to, when the user generates a VK_UP KeyEvent. If there is no {@link
* org.havi.ui.HNavigable HNavigable} component to move
* "up" to, then null shall be specified.
* @param down The {@link org.havi.ui.HNavigable HNavigable}
* component to move to, when the user generates a VK_DOWN KeyEvent. If there
* is no {@link org.havi.ui.HNavigable HNavigable} component to move
* "down" to, then null shall be specified.
* @param left The {@link org.havi.ui.HNavigable HNavigable}
* component to move to, when the user generates a VK_LEFT KeyEvent. If there
* is no {@link org.havi.ui.HNavigable HNavigable} component to move
* "left" to, then null shall be specified.
* @param right The {@link org.havi.ui.HNavigable HNavigable}
* component to move to, when the user generates a VK_RIGHT KeyEvent. If there
* is no {@link org.havi.ui.HNavigable HNavigable} component to move
* "right" to, then null shall be specified.
*/
public void setFocusTraversal(HNavigable up, HNavigable down, HNavigable left, HNavigable right)
{
return;
}
/**
* Indicates if this component has focus.
*
* @return true if the component has focus, otherwise
* returns false.
*/
public boolean isSelected()
{
return(false);
}
/**
* Associate a sound with gaining focus, i.e. when the {@link
* org.havi.ui.HNavigable HNavigable} receives a
* {@link org.havi.ui.event.HFocusEvent 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 {@link org.havi.ui.HNavigable 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.
*
* @param 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 {@link
* org.havi.ui.HSound HSound}.
*/
public void setGainFocusSound(HSound sound)
{
return;
}
/**
* Associate a sound with losing focus, i.e. when the {@link
* org.havi.ui.HNavigable HNavigable} receives a
* {@link org.havi.ui.event.HFocusEvent 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 {@link
* org.havi.ui.HNavigable 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.
*
* @param 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 {@link
* org.havi.ui.HSound HSound}.
*/
public void setLoseFocusSound(HSound sound)
{
return;
}
/**
* Get the sound associated with the gain focus event.
*
* @return The sound played when the component gains focus. If no
* sound is associated with gaining focus, then null shall be
* returned.
*/
public HSound getGainFocusSound()
{
return(null);
}
/**
* Get the sound associated with the lost focus event.
*
* @return The sound played when the component loses focus. If no
* sound is associated with losing focus, then null shall be
* returned.
*/
public HSound getLoseFocusSound()
{
return(null);
}
/**
* Adds the specified {@link org.havi.ui.event.HFocusListener HFocusListener} to
* receive {@link org.havi.ui.event.HFocusEvent HFocusEvent} events sent from
* this {@link org.havi.ui.HNavigable 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.
*
* @param l the HFocusListener to add
*/
public void addHFocusListener(org.havi.ui.event.HFocusListener l)
{
return;
}
/**
* Removes the specified {@link org.havi.ui.event.HFocusListener HFocusListener}
* so that it no longer receives {@link org.havi.ui.event.HFocusEvent
* HFocusEvent} events from this {@link org.havi.ui.HNavigable 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.
*
* @param l the HFocusListener to remove
*/
public void removeHFocusListener(org.havi.ui.event.HFocusListener l)
{
return;
}
/**
* Retrieve the set of key codes which this component maps to
* navigation targets.
*
* @return an array of key codes, or null if no
* navigation targets are set on this component.
*/
public int[] getNavigationKeys()
{
return(null);
}
/**
* Process an {@link org.havi.ui.event.HFocusEvent
* HFocusEvent} sent to this {@link org.havi.ui.HGraphicButton
* HGraphicButton}.
*
* @param evt the {@link org.havi.ui.event.HFocusEvent
* HFocusEvent} to process.
*/
public void processHFocusEvent(org.havi.ui.event.HFocusEvent evt)
{
return;
}
/**
* Adds the specified
* HActionListener to receive HActionEvent
* events sent from this HGraphicButton. 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.
*
* @param l the HActionListener.
*/
public void addHActionListener(org.havi.ui.event.HActionListener l)
{
return;
}
/**
* Removes the specified
* HActionListener so that it no longer receives
* HActionEvent events from this
* HGraphicButton. 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.
*
* @param l the HActionListener.
*/
public void removeHActionListener(org.havi.ui.event.HActionListener l)
{
return;
}
/**
* Sets the command name for the
* HActionEvent event fired by this HGraphicButton.
*
* @param command a String used to set the action
* command.
* @see org.havi.ui.event.HActionEvent#getActionCommand
*/
public void setActionCommand(String command)
{
return;
}
/**
* Associate a sound to be played when the interaction state of
* the HGraphicButton makes the following transitions:
*
* - {@link org.havi.ui.HState#NORMAL_STATE NORMAL_STATE} to {@link org.havi.ui.HState#ACTIONED_STATE ACTIONED_STATE}
*
- {@link org.havi.ui.HState#FOCUSED_STATE FOCUSED_STATE} to {@link org.havi.ui.HState#ACTIONED_FOCUSED_STATE ACTIONED_FOCUSED_STATE}
*
*
* @param sound the sound to be played, when the component is
* actioned. If sound content is already set, the original content
* is replaced. To remove the sound specify a null
* HSound.
*/
public void setActionSound(HSound sound)
{
return;
}
/**
* Return the last action sound set by the
* setActionSound() method
* or null if no action sound has been set.
*/
public HSound getActionSound()
{
return(null);
}
/**
* Process an HActionEvent sent to this HGraphicButton.
*
* @param evt the HActionEvent to process.
*/
public void processHActionEvent(org.havi.ui.event.HActionEvent evt)
{
return;
}
/**
* Gets the command name for the HActionEvent
* event fired by this HGraphicButton. If this HGraphicButton
* has no action command then an empty string shall be returned.
*
* @return A String representing the command name of the
* HActionEvent fired by this HGraphicButton.
*/
public java.lang.String getActionCommand()
{
return(null);
}
}