Package com.inductiveautomation.factorypmi.designer.eventhandling

Class JythonBuilder

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.factorypmi.designer.eventhandling.JythonBuilder

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

DBBrowserBuilder, NavigationBuilder, PropertySetBuilder, ScriptEditorBuilder, TagSetBuilder

public abstract class JythonBuilder
extends JPanel

Base class for the different action tabs of the event configuration UI.

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
protected VisionDesignerImpl	fpmi
protected ComponentScriptEditor	parent

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
JythonBuilder(LayoutManager layout, ComponentScriptEditor parent)

Method Summary

Modifier and Type	Method	Description
protected static void	appendWarning(StringBuilder script, String builderName)
protected static String	applyDictionaryStyleAccess(String str)	Applies dictionary-style access to python statements which may have object member names with spaces in them (see FB3163).
protected static void	buildPropertyReference(StringBuilder realBuilder, String path, PropertyNode valueNode, String compName, String varName, String setValue, String tab)	Generates Jython code, indented by tab, that either gets or sets a property.
protected void	fireNodeUpdated()	Tell the event tree that this event has changed and needs to be redrawn
protected JComponent	getBean()
BindingRoot	getBindingRoot()
abstract String	getDisplayName()
abstract Icon	getIcon()
MethodDescriptorNode	getMethodNode()
protected PropertyNode	getPropertyNode(String path)
Icon	getSpacedIcon()
abstract boolean	handles(MethodDescriptorNode node)	Return true if you're the appropriate type of builder to handle the node as it's currently configured
protected static boolean	isStringNumber(String s)	Returns true if the given string parses out to a number.
protected static String	parseNodePropertyValue(PropertyNode valueNode)
protected PropertyDialog	propertyDialog()	Gets the lazily-created instance of PropertyDialog for this builder pane.
void	setBindingRoot(BindingRoot root)
void	setMethodNode(MethodDescriptorNode methodNode)
abstract void	updateDisplay()	Called when the selected event changes and when the tab is made visible.

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 Details

parent

protected ComponentScriptEditor parent

fpmi

protected VisionDesignerImpl fpmi

Constructor Details

JythonBuilder

public JythonBuilder(LayoutManager layout,
 ComponentScriptEditor parent)

Method Details

setMethodNode

public void setMethodNode(MethodDescriptorNode methodNode)

getMethodNode

public MethodDescriptorNode getMethodNode()

getBean

protected JComponent getBean()

fireNodeUpdated

protected void fireNodeUpdated()

Tell the event tree that this event has changed and needs to be redrawn

updateDisplay

public abstract void updateDisplay()

Called when the selected event changes and when the tab is made visible.

handles

public abstract boolean handles(MethodDescriptorNode node)

Return true if you're the appropriate type of builder to handle the node as it's currently configured

getDisplayName

public abstract String getDisplayName()

getIcon

public abstract Icon getIcon()

getSpacedIcon

public Icon getSpacedIcon()

getBindingRoot

public BindingRoot getBindingRoot()

setBindingRoot

public void setBindingRoot(BindingRoot root)

propertyDialog

protected PropertyDialog propertyDialog()

Gets the lazily-created instance of PropertyDialog for this builder pane.

isStringNumber

protected static boolean isStringNumber(String s)

Returns true if the given string parses out to a number.

getPropertyNode

protected PropertyNode getPropertyNode(String path)

appendWarning

protected static void appendWarning(StringBuilder script,
 String builderName)

buildPropertyReference

protected static void buildPropertyReference(StringBuilder realBuilder,
 String path,
 PropertyNode valueNode,
 String compName,
 String varName,
 String setValue,
 String tab)

Generates Jython code, indented by tab, that either gets or sets a property.

Parameters:

realBuilder - The buffer that the generated Jython code will be appended to

path - The path to the property to get or set.

valueNode - The PropertyNode for the destination property

compName - The name of a new Jython variable that will be set to the component that owns the property. If this is null, the get/set will be made in a more compressed form

varName - If non-null, the name of a new Jython variable that will be assigned the value of valueNode

setValue - If non-null, the property will be set to this value. Should be pre-quoted if desired.

tab - The tab level for this new code

parseNodePropertyValue

protected static String parseNodePropertyValue(PropertyNode valueNode)

applyDictionaryStyleAccess

protected static String applyDictionaryStyleAccess(String str)

Applies dictionary-style access to python statements which may have object member names with spaces in them (see FB3163). For example: converts foo.Hello World.bar to foo["Hello World"].bar

Parameters:

str - The string to apply dictionary style access rules

Returns:

The string which is modified to follow dictionary style access rules in order to avoid jython syntax errors