com.inductiveautomation.factorypmi.application.components

Class PMIPipe

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.inductiveautomation.vision.api.client.components.model.AbstractVisionComponent

com.inductiveautomation.vision.api.client.components.model.AbstractVisionBufferedComponent

com.inductiveautomation.factorypmi.application.components.PMIPipe

All Implemented Interfaces:

DynamicPropertyProvider, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, QualityMonitor, VisionComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class PMIPipe
extends AbstractVisionBufferedComponent

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	end1Bottom
protected boolean	end1Cap
protected boolean	end1Top
protected boolean	end2Bottom
protected boolean	end2Cap
protected boolean	end2Top
protected java.awt.Color	mainColor
protected java.awt.Color	outlineColor
protected java.awt.Color	secondaryColor

Fields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionBufferedComponent

cachedImg, cacheValid, rect, useAlphaEnabledImage

Fields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionComponent

antialias, context, cursorCode

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.binding.MutableDynamicPropertyProvider

RESERVED_SET_KEY

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

COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS

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

COMPONENT_RUNNING

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
PMIPipe()

Method Summary

Modifier and Type	Method and Description
protected void	drawBuffer(java.awt.Graphics2D g2, int width, int height) Subclasses only need to implement this function to have buffered functionality.
protected void	evaluateOpaque()
java.awt.Color	getMainColor()
java.awt.Color	getOutlineColor()
java.awt.Color	getSecondaryColor()
boolean	isEnd1Bottom()
boolean	isEnd1Cap()
boolean	isEnd1Top()
boolean	isEnd2Bottom()
boolean	isEnd2Cap()
boolean	isEnd2Top()
boolean	isOpaque()
void	setEnd1Bottom(boolean b)
void	setEnd1Cap(boolean b)
void	setEnd1Top(boolean b)
void	setEnd2Bottom(boolean b)
void	setEnd2Cap(boolean b)
void	setEnd2Top(boolean b)
void	setMainColor(java.awt.Color color)
void	setOutlineColor(java.awt.Color color)
void	setPipeWidth(int w) Deprecated.
void	setSecondaryColor(java.awt.Color color)

Methods inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionBufferedComponent

invalidateBuffer, paintComponent, repaintAndInvalidateBuffer

Methods inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionComponent

getAppContext, getCursorCode, getDataQuality, getDynamicProps, getProperties, getPropertyValue, getQuality, getStyles, getToolTipText, isAntialias, isPropertyDefined, localeChanged, onShutdown, onStartup, paintChildren, setAntialias, setCursorCode, setDataQuality, setDynamicProps, setName, setPropertyValue, setQuality, setStyles, setToolTipText, setVisible, shutdownComponent, startupComponent, updateQuality

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, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintImmediately, paintImmediately, paramString, 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, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update, updateUI

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, getAccessibleContext, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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 Detail

mainColor

protected java.awt.Color mainColor

secondaryColor

protected java.awt.Color secondaryColor

outlineColor

protected java.awt.Color outlineColor

end1Top

protected boolean end1Top

end1Cap

protected boolean end1Cap

end1Bottom

protected boolean end1Bottom

end2Top

protected boolean end2Top

end2Cap

protected boolean end2Cap

end2Bottom

protected boolean end2Bottom

Constructor Detail

PMIPipe

public PMIPipe()

Method Detail

isOpaque

public boolean isOpaque()

Overrides:

isOpaque in class javax.swing.JComponent

evaluateOpaque

protected void evaluateOpaque()

drawBuffer

protected void drawBuffer(java.awt.Graphics2D g2,
                          int width,
                          int height)

Description copied from class: AbstractVisionBufferedComponent

Subclasses only need to implement this function to have buffered functionality. If anything changes about the component (besides component size), such as colors or line thicknesses, call invalidateBuffer() to ensure this is called again on the next repaint

Specified by:

drawBuffer in class AbstractVisionBufferedComponent

Parameters:

g2 - A graphics object that will paint onto the off-screen buffer

getMainColor

public java.awt.Color getMainColor()

getOutlineColor

public java.awt.Color getOutlineColor()

getSecondaryColor

public java.awt.Color getSecondaryColor()

setMainColor

public void setMainColor(java.awt.Color color)

setOutlineColor

public void setOutlineColor(java.awt.Color color)

setSecondaryColor

public void setSecondaryColor(java.awt.Color color)

setPipeWidth

@Deprecated
public void setPipeWidth(int w)

Deprecated.

This is for backwards compatability. This function sets the preferred size so that the new pipe will look the same as the old one with the 'width' property

isEnd1Bottom

public boolean isEnd1Bottom()

isEnd1Cap

public boolean isEnd1Cap()

isEnd1Top

public boolean isEnd1Top()

isEnd2Bottom

public boolean isEnd2Bottom()

isEnd2Cap

public boolean isEnd2Cap()

isEnd2Top

public boolean isEnd2Top()

setEnd1Bottom

public void setEnd1Bottom(boolean b)

setEnd1Cap

public void setEnd1Cap(boolean b)

setEnd1Top

public void setEnd1Top(boolean b)

setEnd2Bottom

public void setEnd2Bottom(boolean b)

setEnd2Cap

public void setEnd2Cap(boolean b)

setEnd2Top

public void setEnd2Top(boolean b)