org.havi.ui.HStaticIcon Maven / Gradle / Ivy
The newest version!
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.HStaticIcon HStaticIcon} is a user interface
component used to display static graphical content which does
not permit the user to navigate (focus) upon it. By default
it uses the {@link org.havi.ui.HGraphicLook HGraphicLook} 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
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}
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.HStaticIcon#setDefaultLook HStaticIcon.setDefaultLook}
{@link org.havi.ui.HStaticIcon#getDefaultLook HStaticIcon.getDefaultLook}
The "look" for this object.
The {@link org.havi.ui.HGraphicLook HGraphicLook} returned from
HStaticIcon.getDefaultLook when this object was created.
{@link org.havi.ui.HStaticIcon#setLook HStaticIcon.setLook}
{@link org.havi.ui.HStaticIcon#getLook HStaticIcon.getLook}
*/
public class HStaticIcon
extends HVisible
implements HNoInputPreferred
{
/**
* Creates an {@link org.havi.ui.HStaticIcon HStaticIcon}
* 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 HStaticIcon()
{
}
/**
* Creates an {@link org.havi.ui.HStaticIcon HStaticIcon}
* 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 HStaticIcon(Image imageNormal, int x, int y, int width, int height)
{
}
/**
* Creates an {@link org.havi.ui.HStaticIcon HStaticIcon}
* 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 HStaticIcon(Image imageNormal)
{
}
/**
* Sets the {@link org.havi.ui.HLook HLook} for this component.
*
* @param hlook The {@link org.havi.ui.HLook HLook} that is to be
* used for this component.
* Note that this parameter may be null, in which case the
* component will not draw itself until a look is set.
* @exception HInvalidLookException If the {@link
* org.havi.ui.HLook HLook} is not an {@link
* org.havi.ui.HGraphicLook HGraphicLook}. */
public void setLook(HLook hlook) throws HInvalidLookException
{
}
/**
* Sets the default {@link org.havi.ui.HLook HLook} for further
* {@link org.havi.ui.HStaticIcon HStaticIcon} Components.
*
* @param hlook The {@link org.havi.ui.HLook HLook} that will be
* used by default when creating a new {@link
* org.havi.ui.HStaticIcon HStaticIcon} 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.HStaticIcon HStaticIcon}
* components.
*
* @return The {@link org.havi.ui.HLook HLook} that is used by
* default when creating a new {@link org.havi.ui.HStaticIcon
* HStaticIcon} component.
*/
public static HGraphicLook getDefaultLook()
{
return (null);
}
}