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

Class ProgressBarComponent

java.lang.Object

com.ptc.core.components.rendering.AbstractGuiComponent

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

com.ptc.core.components.rendering.guicomponents.ProgressBarComponent

All Implemented Interfaces:

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

Direct Known Subclasses:

PercentCompleteComponent

public class ProgressBarComponent
extends AbstractGraphicalComponent

This class is the gui component that represents progress bars.

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
String	getJSRendererName()	For detailed description check:GraphicalComponent.getJSRendererName() Supported API: true
GraphicalComponent	newInstance(Object value, Map<String,Object> metaData)	Create a new ProgressBarComponent.
org.json.JSONObject	toJSON()	For detailed description check:GraphicalComponent.toJSON() Supported API: true

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

newInstance

public GraphicalComponent newInstance(Object value,
 Map<String,Object> metaData)
                               throws WTException

Create a new ProgressBarComponent. For detailed description check:

invalid reference

GraphicalComponent#newInstance()

Supported API: true

Parameters:

value - the value of the attribute to render. value may be null.

metaData - a map of the additional data (e.g. begin, end, color, ...) used to render the value metaData may be null.

Returns:

a new GraphicalComponent instance

Throws:

WTException

toJSON

public org.json.JSONObject toJSON()
                           throws WTException

For detailed description check:GraphicalComponent.toJSON()
Supported API: true

Returns:

the JSON object that will be passed to the client-side

Throws:

WTException

getJSRendererName

public String getJSRendererName()

For detailed description check:GraphicalComponent.getJSRendererName()
Supported API: true

Returns:

the name of the JavaScript function that can render the values returned by toJSON().