Class PMIFormattedTextField
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.text.JTextComponent
-
- javax.swing.JTextField
-
- javax.swing.JFormattedTextField
-
- com.inductiveautomation.factorypmi.application.components.PMIFormattedTextField
-
- All Implemented Interfaces:
DynamicPropertyProvider
,LocaleListener
,MutableDynamicPropertyProvider
,StyleProvider
,ComponentLifecycle
,EnabledEx
,QualityMonitor
,VisionComponent
,TouchscreenMouseListener.TouchscreenEnabledComponent
,java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.beans.PropertyChangeListener
,java.io.Serializable
,java.util.EventListener
,javax.accessibility.Accessible
,javax.swing.Scrollable
,javax.swing.SwingConstants
public class PMIFormattedTextField extends javax.swing.JFormattedTextField implements java.beans.PropertyChangeListener, MutableDynamicPropertyProvider, StyleProvider, VisionComponent, TouchscreenMouseListener.TouchscreenEnabledComponent, EnabledEx, LocaleListener
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JFormattedTextField
javax.swing.JFormattedTextField.AbstractFormatter, javax.swing.JFormattedTextField.AbstractFormatterFactory
-
Nested classes/interfaces inherited from class javax.swing.JTextField
javax.swing.JTextField.AccessibleJTextField
-
Nested classes/interfaces inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
antialias
protected VisionClientContext
context
The current ClientContext that is set on startupComponent()protected int
cursorCode
static int
FORMATTED_MASK_MODE
static int
REG_EX_MODE
protected int
touchscreenMode
-
Fields inherited from class javax.swing.JFormattedTextField
COMMIT, COMMIT_OR_REVERT, PERSIST, REVERT
-
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 com.inductiveautomation.vision.api.client.components.model.EnabledEx
DISABLED_BY_PERMISSIONS
-
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 javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
-
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 PMIFormattedTextField()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
evaluateEnabled()
VisionClientContext
getAppContext()
java.lang.String
getCommittedValue()
int
getCursorCode()
int
getDataQuality()
For backwards compatibility with scripts.java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor>
getDynamicProps()
java.lang.String
getFormattedMaskPattern()
DynamicPropertyDescriptor[]
getProperties()
java.lang.Object
getPropertyValue(java.lang.String name)
QualityCode
getQuality()
Retrieves the data quality code.Dataset
getStyles()
int
getTouchscreenMode()
java.lang.String
getTouchscreenPropertyName()
The javabeans-style name of the property to modify.TouchscreenMouseListener.KeyboardStyle
getTouchscreenStyle()
int
getValidationMode()
java.lang.String
getValidationPattern()
This method returns the regular expression string used for validating the formatted text field.boolean
isAllowsInvalid()
boolean
isAntialias()
boolean
isCommitsOnValidEdit()
boolean
isComponentEnabled()
boolean
isOverwriteMode()
boolean
isPropertyDefined(java.lang.String name)
boolean
isTextValid()
This method checks the pattern of the regular expression with the text in the formatted text field.boolean
isTouchscreenEditAllowed()
void
localeChanged(java.util.Locale newLocale)
protected void
paintChildren(java.awt.Graphics g)
protected void
paintComponent(java.awt.Graphics g)
void
propertyChange(java.beans.PropertyChangeEvent e)
Called when a field's "value" property changes.void
reInitFormatter()
void
setAllowsInvalid(boolean bolAllowsInvalid)
void
setAntialias(boolean ignored)
void
setCommitsOnValidEdit(boolean bolCommitsOnValidEdit)
void
setCommittedValue(java.lang.String text)
void
setComponentEnabled(boolean componentEnabled)
void
setCursorCode(int cursorCode)
void
setDataQuality(int value)
void
setDynamicProps(java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> map)
void
setFormattedMaskPattern(java.lang.String strFormattedMaskPattern)
void
setName(java.lang.String newName)
void
setOverwriteMode(boolean bolOverwriteMode)
void
setPropertyValue(java.lang.String name, java.lang.Object value)
void
setQuality(QualityCode value)
Sets the current data quality to the given valuevoid
setStyles(Dataset styleDS)
void
setText(java.lang.String t)
void
setTextValid(boolean bolIsValid)
This is a dummy class so that the isRegExValid method will work correctly.void
setTouchscreenMode(int touchscreenMode)
void
setValidationMode(int validationMode)
void
setValidationPattern(java.lang.String strValidationPattern)
This method holds the regular expression string that is used by the pattern matcher to validate the text of the formatted text field.void
setVisible(boolean visible)
void
shutdownComponent()
Called when the component is now shown anymore.void
startupComponent(VisionClientContext context)
Called when the component is first shown.void
updateQuality(java.lang.String propName, QualityCode quality)
Updates the quality for the given property name.-
Methods inherited from class javax.swing.JFormattedTextField
commitEdit, getActions, getFocusLostBehavior, getFormatter, getFormatterFactory, getUIClassID, getValue, invalidEdit, isEditValid, processFocusEvent, processInputMethodEvent, setDocument, setFocusLostBehavior, setFormatter, setFormatterFactory, setValue
-
Methods inherited from class javax.swing.JTextField
actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setFont, setHorizontalAlignment, setScrollOffset
-
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, viewToModel2D, write
-
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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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, 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, 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, processHierarchyBoundsEvent, processHierarchyEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Field Detail
-
REG_EX_MODE
public static final int REG_EX_MODE
- See Also:
- Constant Field Values
-
FORMATTED_MASK_MODE
public static final int FORMATTED_MASK_MODE
- See Also:
- Constant Field Values
-
touchscreenMode
protected int touchscreenMode
-
antialias
protected boolean antialias
-
cursorCode
protected int cursorCode
-
context
protected VisionClientContext context
The current ClientContext that is set on startupComponent()
-
-
Method Detail
-
getCursorCode
public int getCursorCode()
-
setCursorCode
public void setCursorCode(int cursorCode)
-
isComponentEnabled
public boolean isComponentEnabled()
- Specified by:
isComponentEnabled
in interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled)
- Specified by:
setComponentEnabled
in interfaceEnabledEx
-
evaluateEnabled
public void evaluateEnabled()
- Specified by:
evaluateEnabled
in interfaceEnabledEx
-
setVisible
public void setVisible(boolean visible)
- Overrides:
setVisible
in classjavax.swing.JComponent
-
setName
public void setName(java.lang.String newName)
- Overrides:
setName
in classjava.awt.Component
-
getTouchscreenPropertyName
public java.lang.String getTouchscreenPropertyName()
Description copied from interface:TouchscreenMouseListener.TouchscreenEnabledComponent
The javabeans-style name of the property to modify. Needs a getter and setter.- Specified by:
getTouchscreenPropertyName
in interfaceTouchscreenMouseListener.TouchscreenEnabledComponent
-
isTouchscreenEditAllowed
public boolean isTouchscreenEditAllowed()
- Specified by:
isTouchscreenEditAllowed
in interfaceTouchscreenMouseListener.TouchscreenEnabledComponent
-
getTouchscreenMode
public int getTouchscreenMode()
- Specified by:
getTouchscreenMode
in interfaceTouchscreenMouseListener.TouchscreenEnabledComponent
-
setTouchscreenMode
public void setTouchscreenMode(int touchscreenMode)
-
getTouchscreenStyle
public TouchscreenMouseListener.KeyboardStyle getTouchscreenStyle()
- Specified by:
getTouchscreenStyle
in interfaceTouchscreenMouseListener.TouchscreenEnabledComponent
-
isAntialias
public boolean isAntialias()
-
setAntialias
public void setAntialias(boolean ignored)
-
setTextValid
public void setTextValid(boolean bolIsValid)
This is a dummy class so that the isRegExValid method will work correctly.
-
isTextValid
public boolean isTextValid()
This method checks the pattern of the regular expression with the text in the formatted text field. If the text matches the pattern specified, true is returned, and false, otherwise. If no value is specified by the regular expression pattern, then true is returned.
-
setValidationPattern
public void setValidationPattern(java.lang.String strValidationPattern)
This method holds the regular expression string that is used by the pattern matcher to validate the text of the formatted text field.
-
getValidationPattern
public java.lang.String getValidationPattern()
This method returns the regular expression string used for validating the formatted text field.
-
setAllowsInvalid
public void setAllowsInvalid(boolean bolAllowsInvalid)
-
isAllowsInvalid
public boolean isAllowsInvalid()
-
setOverwriteMode
public void setOverwriteMode(boolean bolOverwriteMode)
-
isOverwriteMode
public boolean isOverwriteMode()
-
setCommitsOnValidEdit
public void setCommitsOnValidEdit(boolean bolCommitsOnValidEdit)
-
isCommitsOnValidEdit
public boolean isCommitsOnValidEdit()
-
setText
public void setText(java.lang.String t)
- Overrides:
setText
in classjavax.swing.text.JTextComponent
-
setCommittedValue
public void setCommittedValue(java.lang.String text)
-
getCommittedValue
public java.lang.String getCommittedValue()
-
propertyChange
public void propertyChange(java.beans.PropertyChangeEvent e)
Called when a field's "value" property changes.- Specified by:
propertyChange
in interfacejava.beans.PropertyChangeListener
-
getValidationMode
public int getValidationMode()
-
setValidationMode
public void setValidationMode(int validationMode)
-
getFormattedMaskPattern
public java.lang.String getFormattedMaskPattern()
-
setFormattedMaskPattern
public void setFormattedMaskPattern(java.lang.String strFormattedMaskPattern)
-
reInitFormatter
public void reInitFormatter()
-
getDynamicProps
public java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> getDynamicProps()
- Specified by:
getDynamicProps
in interfaceMutableDynamicPropertyProvider
-
setDynamicProps
public void setDynamicProps(java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> map)
- Specified by:
setDynamicProps
in interfaceMutableDynamicPropertyProvider
-
setPropertyValue
public void setPropertyValue(java.lang.String name, java.lang.Object value) throws java.lang.ClassCastException
- Specified by:
setPropertyValue
in interfaceDynamicPropertyProvider
- Throws:
java.lang.ClassCastException
-
getPropertyValue
public java.lang.Object getPropertyValue(java.lang.String name)
- Specified by:
getPropertyValue
in interfaceDynamicPropertyProvider
-
getProperties
public DynamicPropertyDescriptor[] getProperties()
- Specified by:
getProperties
in interfaceDynamicPropertyProvider
-
isPropertyDefined
public boolean isPropertyDefined(java.lang.String name)
- Specified by:
isPropertyDefined
in interfaceDynamicPropertyProvider
-
getQuality
public QualityCode getQuality()
Description copied from interface:QualityMonitor
Retrieves the data quality code.- Specified by:
getQuality
in interfaceQualityMonitor
-
getDataQuality
public int getDataQuality()
Description copied from interface:QualityMonitor
For backwards compatibility with scripts. Would be awesome if this could just be a default method, but there's a bug (JDK-8071693) that makes that not work with property introspection.- Specified by:
getDataQuality
in interfaceQualityMonitor
-
setDataQuality
public void setDataQuality(int value)
- Specified by:
setDataQuality
in interfaceQualityMonitor
-
setQuality
public void setQuality(QualityCode value)
Description copied from interface:QualityMonitor
Sets the current data quality to the given value- Specified by:
setQuality
in interfaceQualityMonitor
-
updateQuality
public void updateQuality(java.lang.String propName, QualityCode quality)
Description copied from interface:QualityMonitor
Updates the quality for the given property name. The monitor will then evaluate a new quality based on the quality of its other properties. Overall, the worst quality is chosen.- Specified by:
updateQuality
in interfaceQualityMonitor
-
paintChildren
protected void paintChildren(java.awt.Graphics g)
- Overrides:
paintChildren
in classjavax.swing.JComponent
-
paintComponent
protected void paintComponent(java.awt.Graphics g)
- Overrides:
paintComponent
in classjavax.swing.JComponent
-
getStyles
public Dataset getStyles()
- Specified by:
getStyles
in interfaceStyleProvider
-
setStyles
public void setStyles(Dataset styleDS)
- Specified by:
setStyles
in interfaceStyleProvider
-
startupComponent
public final void startupComponent(VisionClientContext context)
Description copied from interface:ComponentLifecycle
Called when the component is first shown.- Specified by:
startupComponent
in interfaceComponentLifecycle
-
shutdownComponent
public final void shutdownComponent()
Description copied from interface:ComponentLifecycle
Called when the component is now shown anymore. Any long-running processes should be stopped. All bindings will have also been shutdown.- Specified by:
shutdownComponent
in interfaceComponentLifecycle
-
getAppContext
public VisionClientContext getAppContext()
- Specified by:
getAppContext
in interfaceComponentLifecycle
-
localeChanged
public void localeChanged(java.util.Locale newLocale)
- Specified by:
localeChanged
in interfaceLocaleListener
-
-