com.inductiveautomation.factorypmi.application.components

Class PMINumericTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

javax.swing.JFormattedTextField

com.inductiveautomation.vision.api.client.components.model.BaseFormattedTextField

com.inductiveautomation.factorypmi.application.components.PMINumericTextField

All Implemented Interfaces:

DynamicPropertyProvider, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, EnabledEx, QualityMonitor, VisionComponent, TouchscreenMouseListener.TouchscreenEnabledComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants

public class PMINumericTextField
extends BaseFormattedTextField

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

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 and Description
static int	MODE_DOUBLE
static int	MODE_FLOAT
static int	MODE_INT
static int	MODE_LONG

Fields inherited from class com.inductiveautomation.vision.api.client.components.model.BaseFormattedTextField

commitOnFocusLost, context, cursorCode, editableBackground, nonEditableBackground, protectedMode, rejectUpdatesDuringEdit, 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.binding.MutableDynamicPropertyProvider

RESERVED_SET_KEY

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponent

COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS

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

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

Constructor Summary

Constructors

Constructor and Description
PMINumericTextField()

Method Summary

Modifier and Type	Method and Description
void	commitEdit() Don't call this method outside of the Event Dispatch thread because commitsPossible is assumed to be checked serially on the event dispatch thread.
java.lang.String	getDecimalFormat()
double	getDoubleValue() If getValue() is outside the range of a double, TypeUtilities will display an error and we'll show 0 as the value.
float	getFloatValue() If we're in float mode or in the range of a float, try to display the float value, throwing an error if it can't be evaluated as a float.
int	getIntValue() If we're in int mode or in the range of a int, try to display the int value, throwing an error if it can't be evaluated as a int.
long	getLongValue() If we're in long mode or in the range of a long, try to display the long value, throwing an error if it can't be evaluated as a long.
double	getMaximum()
double	getMinimum()
int	getMode()
java.lang.Class	getModeType()
java.lang.String	getOutOfBoundsMessage()
java.lang.String	getSuffix()
java.lang.String	getTouchscreenPropertyName() The javabeans-style name of the property to modify.
TouchscreenMouseListener.KeyboardStyle	getTouchscreenStyle()
double	getTouchscreenValue()
boolean	isDeferUpdates()
boolean	isErrorOnOutOfBounds()
boolean	isUseBounds()
protected javax.swing.JFormattedTextField.AbstractFormatterFactory	newFormatterFactory() Subclasses must implement this to create the formatter factory of the type they want to use
protected void	onStartup() Subclasses should override this to provide startup logic.
void	setDecimalFormat(java.lang.String decimalFormat)
void	setDeferUpdates(boolean deferUpdates)
void	setDoubleValue(double doubleValue)
void	setErrorOnOutOfBounds(boolean errorOnOutOfBounds)
void	setFloatValue(float floatValue)
void	setIntValue(int intValue)
void	setLongValue(long longValue)
void	setMaximum(double maximum)
void	setMinimum(double minimum)
void	setMode(int mode)
void	setOutOfBoundsMessage(java.lang.String outOfBoundsMessage)
void	setSuffix(java.lang.String suffix)
void	setTouchscreenValue(double value)
void	setUseBounds(boolean useBounds)
void	setValue(java.lang.Object obj)
java.lang.String	toString()

Methods inherited from class com.inductiveautomation.vision.api.client.components.model.BaseFormattedTextField

_setEditable, evaluateEnabled, getAppContext, getCursorCode, getDataQuality, getDynamicProps, getEditableBackground, getNonEditableBackground, getProperties, getPropertyValue, getQuality, getSelectedText, getStyles, getToolTipText, getTouchscreenMode, isCommitOnFocusLost, isComponentEnabled, isEditing, isPropertyDefined, isProtectedMode, isRejectUpdatesDuringEdit, isTouchscreenEditAllowed, localeChanged, onShutdown, paintChildren, setAntialias, setCommitOnFocusLost, setComponentEnabled, setCursorCode, setDataQuality, setDynamicProps, setEditable, setEditableBackground, setName, setNonEditableBackground, setPropertyValue, setProtectedMode, setQuality, setRejectUpdatesDuringEdit, setStyles, setToolTipText, setTouchscreenMode, setValueDirect, setVisible, shutdownComponent, startupComponent, updateQuality

Methods inherited from class javax.swing.JFormattedTextField

getActions, getFocusLostBehavior, getFormatter, getFormatterFactory, getUIClassID, getValue, invalidEdit, isEditValid, processFocusEvent, processInputMethodEvent, setDocument, setFocusLostBehavior, setFormatter, setFormatterFactory

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, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintComponent, 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, 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, getPeer, 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, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

MODE_INT

public static final int MODE_INT

See Also:

Constant Field Values

MODE_LONG

public static final int MODE_LONG

See Also:

Constant Field Values

MODE_FLOAT

public static final int MODE_FLOAT

See Also:

Constant Field Values

MODE_DOUBLE

public static final int MODE_DOUBLE

See Also:

Constant Field Values

Constructor Detail

PMINumericTextField

public PMINumericTextField()

Method Detail

isErrorOnOutOfBounds

public boolean isErrorOnOutOfBounds()

setErrorOnOutOfBounds

public void setErrorOnOutOfBounds(boolean errorOnOutOfBounds)

getOutOfBoundsMessage

public java.lang.String getOutOfBoundsMessage()

isDeferUpdates

public boolean isDeferUpdates()

setDeferUpdates

public void setDeferUpdates(boolean deferUpdates)

setOutOfBoundsMessage

public void setOutOfBoundsMessage(java.lang.String outOfBoundsMessage)

newFormatterFactory

protected javax.swing.JFormattedTextField.AbstractFormatterFactory newFormatterFactory()

Description copied from class: BaseFormattedTextField

Subclasses must implement this to create the formatter factory of the type they want to use

Specified by:

newFormatterFactory in class BaseFormattedTextField

toString

public java.lang.String toString()

Overrides:

toString in class java.awt.Component

getModeType

public java.lang.Class getModeType()

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.

getTouchscreenStyle

public TouchscreenMouseListener.KeyboardStyle getTouchscreenStyle()

Specified by:

getTouchscreenStyle in interface TouchscreenMouseListener.TouchscreenEnabledComponent

Overrides:

getTouchscreenStyle in class BaseFormattedTextField

getTouchscreenValue

public double getTouchscreenValue()

setTouchscreenValue

public void setTouchscreenValue(double value)

getMode

public int getMode()

setMode

public void setMode(int mode)

commitEdit

public void commitEdit()
                throws java.text.ParseException

Don't call this method outside of the Event Dispatch thread because commitsPossible is assumed to be checked serially on the event dispatch thread. If you call outside the event dispatch thread, an IllegalStateException will be thrown.

Overrides:

commitEdit in class javax.swing.JFormattedTextField

Throws:

java.text.ParseException

getMaximum

public double getMaximum()

setMaximum

public void setMaximum(double maximum)

getMinimum

public double getMinimum()

setMinimum

public void setMinimum(double minimum)

isUseBounds

public boolean isUseBounds()

setUseBounds

public void setUseBounds(boolean useBounds)

getDoubleValue

public double getDoubleValue()

If getValue() is outside the range of a double, TypeUtilities will display an error and we'll show 0 as the value.

setDoubleValue

public void setDoubleValue(double doubleValue)

getFloatValue

public float getFloatValue()

If we're in float mode or in the range of a float, try to display the float value, throwing an error if it can't be evaluated as a float. Otherwise, display 0 in the props.

Pre 7.7.7, values outside of float range would return the overflowed value, potentially altering the underlying value.

setFloatValue

public void setFloatValue(float floatValue)

getIntValue

public int getIntValue()

If we're in int mode or in the range of a int, try to display the int value, throwing an error if it can't be evaluated as a int. Otherwise, display 0 in the props.

Pre 7.7.7, values outside of int range would return the overflowed value, potentially altering the underlying value.

setIntValue

public void setIntValue(int intValue)

getLongValue

public long getLongValue()

If we're in long mode or in the range of a long, try to display the long value, throwing an error if it can't be evaluated as a long. Otherwise, display 0 in the props.

Pre 7.7.7, values outside of long range would return the overflowed value, potentially altering the underlying value.

setLongValue

public void setLongValue(long longValue)

setValue

public void setValue(java.lang.Object obj)

Overrides:

setValue in class BaseFormattedTextField

getDecimalFormat

public java.lang.String getDecimalFormat()

setDecimalFormat

public void setDecimalFormat(java.lang.String decimalFormat)

onStartup

protected void onStartup()

Description copied from class: BaseFormattedTextField

Subclasses should override this to provide startup logic.

Overrides:

onStartup in class BaseFormattedTextField

getSuffix

public java.lang.String getSuffix()

setSuffix

public void setSuffix(java.lang.String suffix)