Package com.inductiveautomation.ignition.designer.sqltags.editor

Class ExpressionCategory

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.jidesoft.dialog.AbstractPage

com.jidesoft.dialog.AbstractDialogPage

com.inductiveautomation.ignition.designer.gui.AbstractListDialogPage

com.inductiveautomation.ignition.designer.sqltags.editor.AbstractEditingCategory

com.inductiveautomation.ignition.designer.sqltags.editor.AbstractTagEditingCategory

com.inductiveautomation.ignition.designer.sqltags.editor.ExpressionCategory

All Implemented Interfaces:

RelativePathProvider, com.jidesoft.dialog.Laziness, ImageObserver, MenuContainer, Serializable, Accessible

public class ExpressionCategory
extends AbstractTagEditingCategory
implements RelativePathProvider

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ExpressionCategory.ExpressionEditorSubpanel	Subpanel to allow users to enter the expression for an expression tag.
protected class	ExpressionCategory.ExpressionTagPropEditor

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 inherited from class com.inductiveautomation.ignition.designer.sqltags.editor.AbstractTagEditingCategory

allFields, editTarget

Fields inherited from class com.jidesoft.dialog.AbstractDialogPage

_buttonEvent, _description, _icon, _pageEnabled, _parentPage, _title, DESCRIPTION_PROPERTY, ICON_PROPERTY, PROPERTY_PAGE_ENABLED, TITLE_PROPERTY

Fields inherited from class com.jidesoft.dialog.AbstractPage

_pageEvent, INVOKE_ON_ALL, INVOKE_ON_NONE, INVOKE_ON_PAINT, INVOKE_ON_REPAINT, INVOKE_ON_UPDATE, INVOKE_ON_VALIDATE

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

Constructor	Description
ExpressionCategory(DesignerContext context)
ExpressionCategory(DesignerContext context, TagReferenceSelectionFactory selFactory, FunctionFactory functionFactory)

Method Summary

Modifier and Type	Method	Description
boolean	dryRunCommit()	Performs a dry run commit.
boolean	getShowWritebackPanel()
TagPath	getTagPath()	The tag that the new path will be relative to.
void	init(TagEditController tag)	Sets the selection to the given tag.
protected void	initComponents()
boolean	isRelevantFor(TagEditController tag)	Returns true if this category is relevant for the given tag.
boolean	restrictToSameSource()	Returns whether or not the new tag reference must be in the under the same tag provider as the current tag.
protected void	setCurrentExpressionType(ExpressionType type)
void	setSameSourceRestrictionOverride(boolean value)	Overrides the logic for same source restrictions.

Methods inherited from class com.inductiveautomation.ignition.designer.sqltags.editor.AbstractTagEditingCategory

commit, getCurrentTarget, hasTarget, isChanged, isDataset, registerEditor

Methods inherited from class com.inductiveautomation.ignition.designer.sqltags.editor.AbstractEditingCategory

clearError, createBanner, lazyInitialize, setError

Methods inherited from class com.inductiveautomation.ignition.designer.gui.AbstractListDialogPage

isGroup

Methods inherited from class com.jidesoft.dialog.AbstractDialogPage

addButtonListener, fireButtonEvent, fireButtonEvent, fireButtonEvent, focusDefaultFocusComponent, getButtonListeners, getDefaultFocusComponent, getDescription, getFullTitle, getIcon, getParentPage, getTitle, isPageEnabled, removeButtonListener, setDefaultFocusComponent, setDescription, setIcon, setPageEnabled, setParentPage, setTitle

Methods inherited from class com.jidesoft.dialog.AbstractPage

addPageListener, allowClosing, firePageEvent, firePageEvent, getInvokeCondition, getPageListeners, initialize, invalidate, paint, paintAll, paintComponents, removePageListener, repaint, repaint, repaint, repaint, reset, revalidate, setAllowClosing, setInvokeCondition, update

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, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, 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

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, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, 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, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

Constructor Details

ExpressionCategory

public ExpressionCategory(DesignerContext context)

ExpressionCategory

public ExpressionCategory(DesignerContext context,
 TagReferenceSelectionFactory selFactory,
 FunctionFactory functionFactory)

Method Details

getTagPath

public TagPath getTagPath()

Description copied from interface: RelativePathProvider

The tag that the new path will be relative to. NOTE: Expects the full path to the tag, not the tag's parent folder.

Specified by:

getTagPath in interface RelativePathProvider

getShowWritebackPanel

public boolean getShowWritebackPanel()

restrictToSameSource

public boolean restrictToSameSource()

Description copied from interface: RelativePathProvider

Returns whether or not the new tag reference must be in the under the same tag provider as the current tag.

Specified by:

restrictToSameSource in interface RelativePathProvider

setSameSourceRestrictionOverride

public void setSameSourceRestrictionOverride(boolean value)

Overrides the logic for same source restrictions. TRUE means that there will be no restriction on source.

init

public void init(@Nonnull
 TagEditController tag)

Description copied from class: AbstractTagEditingCategory

Sets the selection to the given tag.

Overrides:

init in class AbstractTagEditingCategory

Parameters:

tag - the tag to select

dryRunCommit

public boolean dryRunCommit()

Description copied from class: AbstractTagEditingCategory

Performs a dry run commit.

Overrides:

dryRunCommit in class AbstractTagEditingCategory

Returns:

returning TRUE if the edits are valid, false if an error occurred.

initComponents

protected void initComponents()

isRelevantFor

public boolean isRelevantFor(TagEditController tag)

Description copied from class: AbstractTagEditingCategory

Returns true if this category is relevant for the given tag. If the category isn't relevant, it will not be initialized, and will be disabled in the UI.

Specified by:

isRelevantFor in class AbstractTagEditingCategory

Returns:

true if this editing category applies to the tag

setCurrentExpressionType

protected void setCurrentExpressionType(ExpressionType type)