Package com.inductiveautomation.factorypmi.application.components

Class PMIProgressBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JProgressBar

com.inductiveautomation.factorypmi.application.components.PMIProgressBar

All Implemented Interfaces:

DynamicPropertyProvider, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, DesignerInitializable, EnabledEx, QualityMonitor, VisionComponent, ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

public class PMIProgressBar
extends JProgressBar
implements DesignerInitializable, MutableDynamicPropertyProvider, StyleProvider, VisionComponent, EnabledEx, LocaleListener

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JProgressBar

JProgressBar.AccessibleJProgressBar

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	antialias
protected VisionClientContext	context	The current ClientContext that is set on startupComponent()
protected int	cursorCode
protected int	direction
static final int	LEFT_TO_RIGHT
static final int	RIGHT_TO_LEFT

Fields inherited from class javax.swing.JProgressBar

changeEvent, changeListener, model, orientation, paintBorder, paintString, progressString

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle

COMPONENT_RUNNING

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledEx

DISABLED_BY_PERMISSIONS

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListener

LOCAL_CHANGE_EVENT

Fields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider

RESERVED_SET_KEY

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponent

COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS

Constructor Summary

Constructors

Constructor	Description
PMIProgressBar()

Method Summary

Modifier and Type	Method	Description
void	evaluateEnabled()
VisionClientContext	getAppContext()
int	getCursorCode()
int	getDataQuality()	For backwards compatibility with scripts.
int	getDirection()
TreeMap<String,DynamicPropertyDescriptor>	getDynamicProps()
DynamicPropertyDescriptor[]	getProperties()
Object	getPropertyValue(String name)
QualityCode	getQuality()	Retrieves the data quality code.
Dataset	getStyles()
Color	getTextColor()
int	getValue()
void	initialize()
boolean	isAntialias()
boolean	isComponentEnabled()
boolean	isHorizontal()
boolean	isOpaque()
boolean	isPropertyDefined(String name)
void	localeChanged(Locale newLocale)
protected void	paintChildren(Graphics g)
protected void	paintComponent(Graphics g)
void	setAntialias(boolean ignored)
void	setComponentEnabled(boolean componentEnabled)
void	setCursorCode(int cursorCode)
void	setDataQuality(int value)
void	setDirection(int direction)
void	setDynamicProps(TreeMap<String,DynamicPropertyDescriptor> map)
void	setHorizontal(boolean b)
void	setIndeterminate(boolean newValue)
void	setMaximum(int n)
void	setMinimum(int n)
void	setName(String newName)
void	setOpaque(boolean isOpaque)
void	setPropertyValue(String name, Object value)
void	setQuality(QualityCode value)	Sets the current data quality to the given value
void	setStyles(Dataset styleDS)
void	setTextColor(Color textColor)
void	setValue(int value)
void	setVisible(boolean visible)
final void	shutdownComponent()	Called when the component is now shown anymore.
final void	startupComponent(VisionClientContext context)	Called when the component is first shown.
void	updateQuality(String propName, QualityCode quality)	Updates the quality for the given property name.

Methods inherited from class javax.swing.JProgressBar

addChangeListener, createChangeListener, fireStateChanged, getAccessibleContext, getChangeListeners, getMaximum, getMinimum, getModel, getOrientation, getPercentComplete, getString, getUI, getUIClassID, isBorderPainted, isIndeterminate, isStringPainted, paintBorder, paramString, removeChangeListener, setBorderPainted, setModel, setOrientation, setString, setStringPainted, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

LEFT_TO_RIGHT

public static final int LEFT_TO_RIGHT

See Also:

• Constant Field Values

RIGHT_TO_LEFT

public static final int RIGHT_TO_LEFT

See Also:

• Constant Field Values

direction

protected int direction

cursorCode

protected int cursorCode

antialias

protected boolean antialias

context

protected VisionClientContext context

The current ClientContext that is set on startupComponent()

Constructor Details

PMIProgressBar

public PMIProgressBar()

Method Details

initialize

public void initialize()

Specified by:

initialize in interface DesignerInitializable

setName

public void setName(String newName)

Overrides:

setName in class Component

getCursorCode

public int getCursorCode()

setCursorCode

public void setCursorCode(int cursorCode)

isComponentEnabled

public boolean isComponentEnabled()

Specified by:

isComponentEnabled in interface EnabledEx

setComponentEnabled

public void setComponentEnabled(boolean componentEnabled)

Specified by:

setComponentEnabled in interface EnabledEx

evaluateEnabled

public void evaluateEnabled()

Specified by:

evaluateEnabled in interface EnabledEx

setVisible

public void setVisible(boolean visible)

Overrides:

setVisible in class JComponent

isHorizontal

public boolean isHorizontal()

setHorizontal

public void setHorizontal(boolean b)

setIndeterminate

public void setIndeterminate(boolean newValue)

Overrides:

setIndeterminate in class JProgressBar

setMaximum

public void setMaximum(int n)

Overrides:

setMaximum in class JProgressBar

setMinimum

public void setMinimum(int n)

Overrides:

setMinimum in class JProgressBar

getValue

public int getValue()

Overrides:

getValue in class JProgressBar

setValue

public void setValue(int value)

Overrides:

setValue in class JProgressBar

getDirection

public int getDirection()

setDirection

public void setDirection(int direction)

getTextColor

public Color getTextColor()

setTextColor

public void setTextColor(Color textColor)

isAntialias

public boolean isAntialias()

setAntialias

public void setAntialias(boolean ignored)

setOpaque

public void setOpaque(boolean isOpaque)

Overrides:

setOpaque in class JComponent

isOpaque

public boolean isOpaque()

Overrides:

isOpaque in class JComponent

getDynamicProps

public TreeMap<String,DynamicPropertyDescriptor> getDynamicProps()

Specified by:

getDynamicProps in interface MutableDynamicPropertyProvider

setDynamicProps

public void setDynamicProps(TreeMap<String,DynamicPropertyDescriptor> map)

Specified by:

setDynamicProps in interface MutableDynamicPropertyProvider

setPropertyValue

public void setPropertyValue(String name,
 Object value)
                      throws ClassCastException

Specified by:

setPropertyValue in interface DynamicPropertyProvider

Throws:

ClassCastException

getPropertyValue

public Object getPropertyValue(String name)

Specified by:

getPropertyValue in interface DynamicPropertyProvider

getProperties

public DynamicPropertyDescriptor[] getProperties()

Specified by:

getProperties in interface DynamicPropertyProvider

isPropertyDefined

public boolean isPropertyDefined(String name)

Specified by:

isPropertyDefined in interface DynamicPropertyProvider

getQuality

public QualityCode getQuality()

Description copied from interface: QualityMonitor

Retrieves the data quality code.

Specified by:

getQuality in interface QualityMonitor

getDataQuality

public int getDataQuality()

Description copied from interface: QualityMonitor

For backwards compatibility with scripts. Would be awesome if this could just be a default method, but there's a bug (JDK-8071693) that makes that not work with property introspection.

Specified by:

getDataQuality in interface QualityMonitor

setDataQuality

public void setDataQuality(int value)

Specified by:

setDataQuality in interface QualityMonitor

setQuality

public void setQuality(QualityCode value)

Description copied from interface: QualityMonitor

Sets the current data quality to the given value

Specified by:

setQuality in interface QualityMonitor

updateQuality

public void updateQuality(String propName,
 QualityCode quality)

Description copied from interface: QualityMonitor

Updates the quality for the given property name. The monitor will then evaluate a new quality based on the quality of its other properties. Overall, the worst quality is chosen.

Specified by:

updateQuality in interface QualityMonitor

paintChildren

protected void paintChildren(Graphics g)

Overrides:

paintChildren in class JComponent

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

getStyles

public Dataset getStyles()

Specified by:

getStyles in interface StyleProvider

setStyles

public void setStyles(Dataset styleDS)

Specified by:

setStyles in interface StyleProvider

startupComponent

public final void startupComponent(VisionClientContext context)

Description copied from interface: ComponentLifecycle

Called when the component is first shown.

Specified by:

startupComponent in interface ComponentLifecycle

shutdownComponent

public final void shutdownComponent()

Description copied from interface: ComponentLifecycle

Called when the component is now shown anymore. Any long-running processes should be stopped. All bindings will have also been shutdown.

Specified by:

shutdownComponent in interface ComponentLifecycle

getAppContext

public VisionClientContext getAppContext()

Specified by:

getAppContext in interface ComponentLifecycle

localeChanged

public void localeChanged(Locale newLocale)

Specified by:

localeChanged in interface LocaleListener