Package com.inductiveautomation.factorypmi.application.components

Class BasicContainer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

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

com.inductiveautomation.factorypmi.application.components.BasicContainer

All Implemented Interfaces:

DynamicPropertyProvider, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, QualityMonitor, VisionComponent, VisionContainer, ImageObserver, MenuContainer, VetoableChangeListener, Serializable, EventListener, Accessible

Direct Known Subclasses:

VisionTemplate

public class BasicContainer
extends AbstractVisionPanel
implements VisionContainer

The SpringPanel is the container for FactoryPMI. A lightweight subclass of JPanel, this panel always uses the FPMILayout for its layout manager. add() is overwritten and privateAdd() used instead to ensure that adding logic is always correct. The name SpringPanel is a historical leftover, as SpringLayout was used in earlier versions.

See Also:

• Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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
static final String	PANEL_CONTAINS_DEFAULT_BTN	This string is used as a JComponent client property key if the panel contains a default button, or contains a panel who contains a default button.

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

antialias, context, cursorCode, dynamicProps

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 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 com.inductiveautomation.vision.api.client.components.model.VisionComponent

COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS

Constructor Summary

Constructors

Constructor	Description
BasicContainer()
BasicContainer(String name)

Method Summary

Modifier and Type	Method	Description
Component	add(Component comp)
void	addComponent(Component comp)
Component	getComponent(String name)
static String	getNextName(VisionContainer container, String name)
int	getPosition(Component comp)
SpringInfo	getSpringInfo(Component comp)
SpringLayout	getSpringLayout()
String	getTexturePath()
static void	initializeName(Component newComponent, VisionContainer container)
boolean	isCombineRepaints()
boolean	isGroup()
boolean	isOffsettingContainer()
boolean	isOptimizedDrawingEnabled()
boolean	layoutAsGroup()
void	moveBackward(Component comp)
void	moveForward(Component comp)
void	moveToBack(Component comp)
void	moveToFront(Component comp)
protected void	paintBackground(Graphics g)
void	paintComponent(Graphics g)
protected boolean	paintOverlayOverChildren()
protected void	paintTexture(Graphics g)
void	privateAdd(Component comp)	Only for use with classes that know how to use the BasicContainer.
void	putSpringInfo(Component comp, SpringInfo si)	Deprecated.
void	remove(Component comp)
static String	sanitizeName(String name)
void	setBackground(Color bg)
void	setBoundsEx(Rectangle2D r2d)	This helps the serializer call the correct bounds setting method.
void	setCombineRepaints(boolean groupDrawingEnabled)
void	setForeground(Color fg)
void	setGroup(boolean group)
void	setLayout(LayoutManager mgr)
void	setLocked(Component c, boolean lock)	Deprecated.
void	setOpaque(boolean b)
void	setOptimizedDrawingEnabled(boolean b)
void	setPosition(Component comp, int i)
void	setPreferredBoundsEx(Rectangle2D r2d)
void	setRotation(int i)
void	setSecuritySettings(String name, SecuritySettings settings)	Deprecated.
void	setTexturePath(String texturePath)
String	toString()
static boolean	validateName(String name)
static void	validateName(String newName, VisionContainer container, Component component)
void	vetoableChange(PropertyChangeEvent evt)

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

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

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

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, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

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

getAppContext, shutdownComponent, startupComponent

Methods inherited from interface com.inductiveautomation.vision.api.client.components.model.QualityMonitor

getDataQuality, getQuality, setDataQuality, setQuality, updateQuality

Methods inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionContainer

getComponent, getComponentCount, getComponents, getParent, repaint, revalidate

Field Details

PANEL_CONTAINS_DEFAULT_BTN

public static final String PANEL_CONTAINS_DEFAULT_BTN

This string is used as a JComponent client property key if the panel contains a default button, or contains a panel who contains a default button. The value of the JComponent client property is the button to make 'default'. Because of how deserialization sets fields before adding components to their parent, the HMIButton cannot truly register itself as default upon deserialization, so the button is passed up to enclosing RootPaneContainer (FHMIWindow) via this property.

See Also:

• Constant Field Values

Constructor Details

BasicContainer

public BasicContainer()

BasicContainer

public BasicContainer(String name)

Method Details

setBoundsEx

public void setBoundsEx(Rectangle2D r2d)

This helps the serializer call the correct bounds setting method.

setPreferredBoundsEx

public void setPreferredBoundsEx(Rectangle2D r2d)

getSpringLayout

public SpringLayout getSpringLayout()

setLayout

public void setLayout(LayoutManager mgr)

Overrides:

setLayout in class Container

isOptimizedDrawingEnabled

public boolean isOptimizedDrawingEnabled()

Overrides:

isOptimizedDrawingEnabled in class JComponent

setOptimizedDrawingEnabled

public void setOptimizedDrawingEnabled(boolean b)

isCombineRepaints

public boolean isCombineRepaints()

setCombineRepaints

public void setCombineRepaints(boolean groupDrawingEnabled)

add

public Component add(Component comp)

Overrides:

add in class Container

addComponent

public void addComponent(Component comp)

Specified by:

addComponent in interface VisionContainer

initializeName

public static void initializeName(Component newComponent,
 VisionContainer container)

privateAdd

public void privateAdd(Component comp)

Only for use with classes that know how to use the BasicContainer. Enforces name uniqueness by calling getNextName(VisionContainer, String) if a name collision is detected.

getNextName

public static String getNextName(VisionContainer container,
 String name)

getComponent

public Component getComponent(String name)

Specified by:

getComponent in interface VisionContainer

vetoableChange

public void vetoableChange(PropertyChangeEvent evt)
                    throws PropertyVetoException

Specified by:

vetoableChange in interface VetoableChangeListener

Throws:

PropertyVetoException

validateName

public static void validateName(String newName,
 VisionContainer container,
 Component component)
                         throws IllegalArgumentException

Throws:

IllegalArgumentException

validateName

public static boolean validateName(String name)

sanitizeName

public static String sanitizeName(String name)

remove

public void remove(Component comp)

Specified by:

remove in interface VisionContainer

Overrides:

remove in class Container

moveToFront

public void moveToFront(Component comp)

moveToBack

public void moveToBack(Component comp)

moveForward

public void moveForward(Component comp)

moveBackward

public void moveBackward(Component comp)

paintComponent

public void paintComponent(Graphics g)

Overrides:

paintComponent in class AbstractVisionPanel

paintBackground

protected void paintBackground(Graphics g)

paintTexture

protected void paintTexture(Graphics g)

paintOverlayOverChildren

protected boolean paintOverlayOverChildren()

Overrides:

paintOverlayOverChildren in class AbstractVisionPanel

setPosition

public void setPosition(Component comp,
 int i)

Specified by:

setPosition in interface VisionContainer

getPosition

public int getPosition(Component comp)

isOffsettingContainer

public boolean isOffsettingContainer()

Specified by:

isOffsettingContainer in interface VisionContainer

getSpringInfo

public SpringInfo getSpringInfo(Component comp)

putSpringInfo

@Deprecated
public void putSpringInfo(Component comp,
 SpringInfo si)

Deprecated.

This call is from a SpringPanel that was serialized with SpringLayout. Try to look at the SpringInfo class to see what kind of new layout constraints to give the component

setRotation

public void setRotation(int i)

toString

public String toString()

Overrides:

toString in class Component

setLocked

@Deprecated
public void setLocked(Component c,
 boolean lock)

Deprecated.

setOpaque

public void setOpaque(boolean b)

Overrides:

setOpaque in class JComponent

setSecuritySettings

@Deprecated
public void setSecuritySettings(String name,
 SecuritySettings settings)

Deprecated.

For serialization.

setBackground

public void setBackground(Color bg)

Overrides:

setBackground in class JComponent

setForeground

public void setForeground(Color fg)

Overrides:

setForeground in class JComponent

isGroup

public boolean isGroup()

setGroup

public void setGroup(boolean group)

layoutAsGroup

public boolean layoutAsGroup()

Specified by:

layoutAsGroup in interface VisionContainer

getTexturePath

public String getTexturePath()

setTexturePath

public void setTexturePath(String texturePath)