org.havi.ui.HListElement Maven / Gradle / Ivy
package org.havi.ui;
import java.awt.Image;
/*
* Copyright 2000-2003 by HAVi, Inc. Java is a trademark of Sun
* Microsystems, Inc. All rights reserved.
*/
/**
{@link org.havi.ui.HListElement HListElement} is a holder for
content used with the {@link org.havi.ui.HListGroup HListGroup}
component. It must contain a text string, and may also contain a
single graphical image.
Applications should not directly manipulate
HListElement objects. They are intended
to be used in conjunction with an {@link org.havi.ui.HListGroup}
which maintains a list of them, and is responsible for
their rendering via the {@link org.havi.ui.HListGroupLook}
class. The methods setIcon() and
setLabel() of HListElement shall not be
used for elements, which are part of HListGroup. If an
application requires to alter the content, it shall either replace
the entire element, or remove it temporarily and re-add it after
the content was changed.
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
label
text content of this item
no default
-
{@link org.havi.ui.HListElement#getLabel getLabel}
icon
image content of this item
null
-
{@link org.havi.ui.HListElement#getIcon getIcon}
Default parameter values not exposed in the constructors
Description Default value Set method
Get method None.
@see HListGroup
@see HListGroupLook
*/
public class HListElement
{
/**
* Creates an HListElement object. See the class description for
* details of constructor parameters and default values.
* @param label The label for this HListElement.
*/
public HListElement(String label)
{
}
/**
* Creates an HListElement object. See the class description for
* details of constructor parameters and default values.
* @param icon The icon for this HListElement.
* @param label The label for this HListElement.
*/
public HListElement(Image icon, String label)
{
}
/**
* Retrieve the label for this HListElement.
*
* @return the text label for this HListElement.
*/
public String getLabel()
{
return (null);
}
/**
* Retrieve the icon for this HListElement.
*
* @return the graphical icon for this HListElement, or
* null if no icon was set.
*/
public Image getIcon()
{
return (null);
}
/**
* Set the label for this HListElement.
* @param label The label for this HListElement.
*/
public void setLabel(String label)
{
}
/**
* Set the icon for this HListElement. If icon is null,
* the HListElement will be in the same state as if no icon was set.
* @param icon The icon for this HListElement.
*/
public void setIcon(Image icon)
{
}
}