Package com.inductiveautomation.perspective.designer.project.properties

Class AbstractPerspectivePropsPanel<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.ignition.designer.propertyeditor.AbstractPropertyEditorPanel

com.inductiveautomation.perspective.designer.project.properties.AbstractPerspectivePropsPanel<T>

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

Direct Known Subclasses:

PerspectiveIdleTimeoutPropsPanel, PerspectivePermissionsPropsPanel, PerspectivePropsPanel, TagDropConfigPropsPanel

public abstract class AbstractPerspectivePropsPanel<T>
extends AbstractPropertyEditorPanel

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.designer.propertyeditor.AbstractPropertyEditorPanel

AbstractPropertyEditorPanel.ComponentChangeListener, AbstractPropertyEditorPanel.State

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

javax.swing.JPanel.AccessibleJPanel

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	Description
protected com.inductiveautomation.ignition.common.gson.Gson	gson

Fields inherited from class com.inductiveautomation.ignition.designer.propertyeditor.AbstractPropertyEditorPanel

changed, state

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPerspectivePropsPanel(java.lang.Class<T> configClass, java.awt.LayoutManager layout)

Method Summary

Modifier and Type	Method	Description
protected T	createDefaultConfigObject()
java.lang.Object	deserialize(DesignerContext context, byte[] data)	Turn bytes stored in this panel's project resource into the correct object type for this panel.
int	getResourceScope()	The application scope for the ProjectResource that represents this property category
void	initProps(java.lang.Object props)	Initialize the page with the given properties.
protected abstract void	initPropsInternal(T config)
byte[]	serialize(DesignerContext context, java.lang.Object object)	Turn the object this panel is editing into a byte[] to be stored in a ProjectResource.

Methods inherited from class com.inductiveautomation.ignition.designer.propertyeditor.AbstractPropertyEditorPanel

addStateChangeListener, commit, dryCommit, getCategory, getListener, getPreferredScrollableViewportSize, getResourceName, getResourceType, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getState, getTitleKey, intValueOf, isChanged, listenTo, listenTo, listenTo, listenTo, listenTo, listenTo, notifyClosed, override, revert, setChanged, setState

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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, 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, setName, 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

gson

protected final com.inductiveautomation.ignition.common.gson.Gson gson

Constructor Detail

AbstractPerspectivePropsPanel

protected AbstractPerspectivePropsPanel(java.lang.Class<T> configClass,
                                        java.awt.LayoutManager layout)

Method Detail

initProps

public final void initProps(java.lang.Object props)

Description copied from class: AbstractPropertyEditorPanel

Initialize the page with the given properties.

Specified by:

initProps in class AbstractPropertyEditorPanel

Parameters:

props - Deserialized object from this page's corresponding ProjectResource, or null if the resource didn't exist.

createDefaultConfigObject

protected T createDefaultConfigObject()

initPropsInternal

protected abstract void initPropsInternal(T config)

getResourceScope

public int getResourceScope()

Description copied from class: AbstractPropertyEditorPanel

The application scope for the ProjectResource that represents this property category

Overrides:

getResourceScope in class AbstractPropertyEditorPanel

serialize

public byte[] serialize(DesignerContext context,
                        java.lang.Object object)
                 throws java.lang.Exception

Description copied from class: AbstractPropertyEditorPanel

Turn the object this panel is editing into a byte[] to be stored in a ProjectResource. Default implementation uses Ignition's XMLSerializer with gzip=true

Overrides:

serialize in class AbstractPropertyEditorPanel

Throws:

java.lang.Exception

deserialize

public java.lang.Object deserialize(DesignerContext context,
                                    byte[] data)
                             throws java.lang.Exception

Description copied from class: AbstractPropertyEditorPanel

Turn bytes stored in this panel's project resource into the correct object type for this panel. Default implementation simply calls ClientContext.deserialize(byte[], Logger)

Overrides:

deserialize in class AbstractPropertyEditorPanel

Throws:

java.lang.Exception