Package com.ptc.core.components.rendering.guicomponents

Class MultiStateIconComponent

java.lang.Object

com.ptc.core.components.rendering.AbstractGuiComponent

com.ptc.core.components.rendering.guicomponents.AbstractGraphicalComponent

com.ptc.core.components.rendering.guicomponents.MultiStateIconComponent

All Implemented Interfaces:

GuiComponent, GraphicalComponent, com.ptc.core.components.rendering.guicomponents.PrintableComponent, GraphicalAttRepresentationHandler, com.ptc.netmarkets.util.misc.NmFormatable, Serializable

Direct Known Subclasses:

TrafficLightComponent

public abstract class MultiStateIconComponent
extends AbstractGraphicalComponent

A multi-state icon component is a graphical representation that renders as one of several icons based an underlying attribute value. This class supports only integer-valued attributes.
Supported API: true

Extendable: true

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.ptc.core.components.rendering.AbstractGuiComponent

componentHidden, divClass, enabled, locale, multiValued, readOnly, renderer, renderWhileHidden, required, valueHidden

Fields inherited from interface com.ptc.core.components.rendering.GuiComponent

NBSP

Fields inherited from interface com.ptc.netmarkets.util.misc.NmFormatable

DIV_CLASS, RENDER_WHILE_HIDDEN, STYLE_CLASSES

Method Summary

Modifier and Type	Method	Description
abstract IconComponent	getIconComponent(int state)	The getIconComponent method should return the icon that corresponds with the int passed in.

Methods inherited from class com.ptc.core.components.rendering.AbstractGuiComponent

_isValueNull, addHiddenField, addOnChangeListenerForDriverAttribute, addStyleClass, draw, getCollationKey, getColumnName, getDivClass, getFilterInternalValue, getHiddenClass, getHiddenFields, getId, getInternalValueString, getLabel, getLocale, getName, getRenderer, getRequiredStyle, getStyleClasses, getStyleClassList, isComponentHidden, isDriverAttribute, isEnabled, isHiddenId, isMultiValued, isReadOnly, isRenderLabel, isRenderLabelOnRight, isRenderWhileHidden, isRequired, isValueHidden, isValueNull, removeStyleClass, setCollationKey, setColumnName, setComponentHidden, setDivClass, setEnabled, setFilterInternalValue, setHiddenId, setHiddenIdClass, setId, setLabel, setLocale, setMultiValued, setName, setReadOnly, setRenderer, setRenderLabel, setRenderLabelOnRight, setRenderWhileHidden, setRequired, setValueHidden, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ptc.core.components.rendering.GuiComponent

addHiddenField, draw, getHiddenFields

Method Details

getIconComponent

public abstract IconComponent getIconComponent(int state)
                                        throws WTException

The getIconComponent method should return the icon that corresponds with the int passed in. It will throw a WTException if the int passed in does not map to a valid state.
Supported API: true

Parameters:

state - the integer corresponding to the returned icon

Returns:

the icon corresponding to "state".

Throws:

WTException - if "state" is an invalid value.