Package com.inductiveautomation.factorypmi.application.components

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, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, Scrollable, SwingConstants

public class PMIFormattedTextField
extends JFormattedTextField
implements PropertyChangeListener, MutableDynamicPropertyProvider, StyleProvider, VisionComponent, TouchscreenMouseListener.TouchscreenEnabledComponent, EnabledEx, LocaleListener

See Also:

• Serialized Form

Nested Class Summary

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

JFormattedTextField.AbstractFormatter, JFormattedTextField.AbstractFormatterFactory

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

JTextField.AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

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 boolean	antialias
protected VisionClientContext	context	The current ClientContext that is set on startupComponent()
protected int	cursorCode
static final int	FORMATTED_MASK_MODE
static final 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.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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

Modifier and Type	Method	Description
void	evaluateEnabled()
VisionClientContext	getAppContext()
String	getCommittedValue()
int	getCursorCode()
int	getDataQuality()	For backwards compatibility with scripts.
TreeMap<String,DynamicPropertyDescriptor>	getDynamicProps()
String	getFormattedMaskPattern()
String	getKeyboardName()	The keyboard layout name preferred by this component.
DynamicPropertyDescriptor[]	getProperties()
Object	getPropertyValue(String name)
QualityCode	getQuality()	Retrieves the data quality code.
Dataset	getStyles()
int	getTouchscreenMode()
String	getTouchscreenPropertyName()	The javabeans-style name of the property to modify.
TouchscreenMouseListener.KeyboardStyle	getTouchscreenStyle()
int	getValidationMode()
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(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(Locale newLocale)
protected void	paintChildren(Graphics g)
protected void	paintComponent(Graphics g)
void	propertyChange(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(String text)
void	setComponentEnabled(boolean componentEnabled)
void	setCursorCode(int cursorCode)
void	setDataQuality(int value)
void	setDynamicProps(TreeMap<String,DynamicPropertyDescriptor> map)
void	setFormattedMaskPattern(String strFormattedMaskPattern)
void	setKeyboardName(String keyboardName)
void	setName(String newName)
void	setOverwriteMode(boolean bolOverwriteMode)
void	setPropertyValue(String name, Object value)
void	setQuality(QualityCode value)	Sets the current data quality to the given value
void	setStyles(Dataset styleDS)
void	setText(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(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)
final void	shutdownComponent()	Called when the component is now shown anymore.
final void	startupComponent(VisionClientContext context)	Called when the component is first shown.
void	updateQuality(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

Methods inherited from class java.lang.Object

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

Field Details

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()

Constructor Details

PMIFormattedTextField

public PMIFormattedTextField()

Method Details

getCursorCode

public int getCursorCode()

setCursorCode

public void setCursorCode(int cursorCode)

isComponentEnabled

public boolean isComponentEnabled()

Specified by:

isComponentEnabled in interface EnabledEx

setComponentEnabled

public void setComponentEnabled(boolean componentEnabled)

Specified by:

setComponentEnabled in interface EnabledEx

evaluateEnabled

public void evaluateEnabled()

Specified by:

evaluateEnabled in interface EnabledEx

setVisible

public void setVisible(boolean visible)

Overrides:

setVisible in class JComponent

setName

public void setName(String newName)

Overrides:

setName in class Component

getTouchscreenPropertyName

public 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 interface TouchscreenMouseListener.TouchscreenEnabledComponent

isTouchscreenEditAllowed

public boolean isTouchscreenEditAllowed()

Specified by:

isTouchscreenEditAllowed in interface TouchscreenMouseListener.TouchscreenEnabledComponent

getTouchscreenMode

public int getTouchscreenMode()

Specified by:

getTouchscreenMode in interface TouchscreenMouseListener.TouchscreenEnabledComponent

setTouchscreenMode

public void setTouchscreenMode(int touchscreenMode)

getTouchscreenStyle

public TouchscreenMouseListener.KeyboardStyle getTouchscreenStyle()

Specified by:

getTouchscreenStyle in interface TouchscreenMouseListener.TouchscreenEnabledComponent

setKeyboardName

public void setKeyboardName(String keyboardName)

getKeyboardName

@Nullable
public String getKeyboardName()

Description copied from interface: TouchscreenMouseListener.TouchscreenEnabledComponent

The keyboard layout name preferred by this component. Return null for automatic selection of a locale & keyboard style appropriate layout.

Specified by:

getKeyboardName in interface TouchscreenMouseListener.TouchscreenEnabledComponent

See Also:

• KeyboardLayoutManager
• InternationalKeypadDialog.showAlphaNumericDialog(Component, String, int, boolean, String)

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(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 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(String t)

Overrides:

setText in class JTextComponent

setCommittedValue

public void setCommittedValue(String text)

getCommittedValue

public String getCommittedValue()

propertyChange

public void propertyChange(PropertyChangeEvent e)

Called when a field's "value" property changes.

Specified by:

propertyChange in interface PropertyChangeListener

getValidationMode

public int getValidationMode()

setValidationMode

public void setValidationMode(int validationMode)

getFormattedMaskPattern

public String getFormattedMaskPattern()

setFormattedMaskPattern

public void setFormattedMaskPattern(String strFormattedMaskPattern)

reInitFormatter

public void reInitFormatter()

getDynamicProps

public TreeMap<String,DynamicPropertyDescriptor> getDynamicProps()

Specified by:

getDynamicProps in interface MutableDynamicPropertyProvider

setDynamicProps

public void setDynamicProps(TreeMap<String,DynamicPropertyDescriptor> map)

Specified by:

setDynamicProps in interface MutableDynamicPropertyProvider

setPropertyValue

public void setPropertyValue(String name,
 Object value)
                      throws ClassCastException

Specified by:

setPropertyValue in interface DynamicPropertyProvider

Throws:

ClassCastException

getPropertyValue

public Object getPropertyValue(String name)

Specified by:

getPropertyValue in interface DynamicPropertyProvider

getProperties

public DynamicPropertyDescriptor[] getProperties()

Specified by:

getProperties in interface DynamicPropertyProvider

isPropertyDefined

public boolean isPropertyDefined(String name)

Specified by:

isPropertyDefined in interface DynamicPropertyProvider

getQuality

public QualityCode getQuality()

Description copied from interface: QualityMonitor

Retrieves the data quality code.

Specified by:

getQuality in interface QualityMonitor

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 interface QualityMonitor

setDataQuality

public void setDataQuality(int value)

Specified by:

setDataQuality in interface QualityMonitor

setQuality

public void setQuality(QualityCode value)

Description copied from interface: QualityMonitor

Sets the current data quality to the given value

Specified by:

setQuality in interface QualityMonitor

updateQuality

public void updateQuality(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 interface QualityMonitor

paintChildren

protected void paintChildren(Graphics g)

Overrides:

paintChildren in class JComponent

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

getStyles

public Dataset getStyles()

Specified by:

getStyles in interface StyleProvider

setStyles

public void setStyles(Dataset styleDS)

Specified by:

setStyles in interface StyleProvider

startupComponent

public final void startupComponent(VisionClientContext context)

Description copied from interface: ComponentLifecycle

Called when the component is first shown.

Specified by:

startupComponent in interface ComponentLifecycle

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 interface ComponentLifecycle

getAppContext

public VisionClientContext getAppContext()

Specified by:

getAppContext in interface ComponentLifecycle

localeChanged

public void localeChanged(Locale newLocale)

Specified by:

localeChanged in interface LocaleListener