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

Class BaseFormattedTextField

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BaseFormattedTextField.SafeFocusHighlightBorder  

      • 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 Description
      protected boolean antialias  
      protected boolean commitOnFocusLost  
      protected VisionClientContext context
      The current ClientContext that is set on startupComponent()
      protected int cursorCode  
      protected java.awt.Color editableBackground  
      protected java.awt.Color nonEditableBackground  
      protected boolean protectedMode  
      protected boolean rejectUpdatesDuringEdit  
      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 java.awt.image.ImageObserver

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

      • 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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void _setEditable​(boolean b)
      Protected accessor to super.setEditable() that bypasses protected mode check
      void evaluateEnabled()  
      VisionClientContext getAppContext()  
      int getCursorCode()  
      int getDataQuality()
      For backwards compatibility with scripts.
      java.util.TreeMap<java.lang.String,​DynamicPropertyDescriptor> getDynamicProps()  
      java.awt.Color getEditableBackground()  
      java.awt.Color getNonEditableBackground()  
      DynamicPropertyDescriptor[] getProperties()  
      java.lang.Object getPropertyValue​(java.lang.String name)  
      QualityCode getQuality()
      Retrieves the data quality code.
      java.lang.String getSelectedText()  
      Dataset getStyles()  
      java.lang.String getToolTipText()  
      int getTouchscreenMode()  
      TouchscreenMouseListener.KeyboardStyle getTouchscreenStyle()  
      boolean isAntialias()  
      boolean isCommitOnFocusLost()  
      boolean isComponentEnabled()  
      protected boolean isEditing()
      Returns true if this text box is currently being edited by the user.
      boolean isOpaque()  
      boolean isPropertyDefined​(java.lang.String name)  
      boolean isProtectedMode()  
      boolean isRejectUpdatesDuringEdit()  
      boolean isTouchscreenEditAllowed()  
      void localeChanged​(java.util.Locale newLocale)  
      protected abstract javax.swing.JFormattedTextField.AbstractFormatterFactory newFormatterFactory()
      Subclasses must implement this to create the formatter factory of the type they want to use
      protected void onShutdown()
      Subclasses should override this to provide shutdown logic.
      protected void onStartup()
      Subclasses should override this to provide startup logic.
      protected void paintChildren​(java.awt.Graphics g)  
      protected void paintComponent​(java.awt.Graphics g)  
      void setAntialias​(boolean ignored)  
      void setCommitOnFocusLost​(boolean commitOnFocusLost)  
      void setComponentEnabled​(boolean componentEnabled)  
      void setCursorCode​(int cursorCode)  
      void setDataQuality​(int value)  
      void setDynamicProps​(java.util.TreeMap<java.lang.String,​DynamicPropertyDescriptor> map)  
      void setEditable​(boolean b)  
      void setEditableBackground​(java.awt.Color editableBackground)  
      void setName​(java.lang.String newName)  
      void setNonEditableBackground​(java.awt.Color nonEditableBackground)  
      void setPropertyValue​(java.lang.String name, java.lang.Object value)  
      void setProtectedMode​(boolean protectedMode)  
      void setQuality​(QualityCode value)
      Sets the current data quality to the given value
      void setRejectUpdatesDuringEdit​(boolean rejectUpdatesDuringEdit)  
      void setStyles​(Dataset styleDS)  
      void setToolTipText​(java.lang.String text)  
      void setTouchscreenMode​(int touchscreenMode)  
      void setValue​(java.lang.Object obj)  
      protected void setValueDirect​(java.lang.Object obj)  
      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

      • 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, modelToView2D, 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, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, 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, 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 Detail

      • context

        protected VisionClientContext context
        The current ClientContext that is set on startupComponent()

      • protectedMode

        protected boolean protectedMode

      • commitOnFocusLost

        protected boolean commitOnFocusLost

      • rejectUpdatesDuringEdit

        protected boolean rejectUpdatesDuringEdit

      • editableBackground

        protected java.awt.Color editableBackground

      • nonEditableBackground

        protected java.awt.Color nonEditableBackground

      • touchscreenMode

        protected int touchscreenMode

      • antialias

        protected boolean antialias

      • cursorCode

        protected int cursorCode

    • Constructor Detail

      • BaseFormattedTextField

        public BaseFormattedTextField()

    • Method Detail

      • newFormatterFactory

        protected abstract javax.swing.JFormattedTextField.AbstractFormatterFactory newFormatterFactory()
        Subclasses must implement this to create the formatter factory of the type they want to use

      • getCursorCode

        public int getCursorCode()

      • setCursorCode

        public void setCursorCode​(int cursorCode)

      • setComponentEnabled

        public void setComponentEnabled​(boolean componentEnabled)
        Specified by:
        setComponentEnabled in interface EnabledEx

      • setName

        public void setName​(java.lang.String newName)
        Overrides:
        setName in class java.awt.Component

      • getToolTipText

        public java.lang.String getToolTipText()
        Overrides:
        getToolTipText in class javax.swing.JComponent

      • getSelectedText

        public java.lang.String getSelectedText()
        Overrides:
        getSelectedText in class javax.swing.text.JTextComponent

      • isAntialias

        public boolean isAntialias()

      • setAntialias

        public void setAntialias​(boolean ignored)

      • setValue

        public void setValue​(java.lang.Object obj)
        Overrides:
        setValue in class javax.swing.JFormattedTextField

      • setValueDirect

        protected void setValueDirect​(java.lang.Object obj)

      • isEditing

        protected boolean isEditing()
        Returns true if this text box is currently being edited by the user. Note that if protected mode is on, they have to double-click in the box first

      • isRejectUpdatesDuringEdit

        public boolean isRejectUpdatesDuringEdit()

      • setRejectUpdatesDuringEdit

        public void setRejectUpdatesDuringEdit​(boolean rejectUpdatesDuringEdit)

      • isProtectedMode

        public boolean isProtectedMode()

      • setProtectedMode

        public void setProtectedMode​(boolean protectedMode)

      • isCommitOnFocusLost

        public boolean isCommitOnFocusLost()

      • setCommitOnFocusLost

        public void setCommitOnFocusLost​(boolean commitOnFocusLost)

      • _setEditable

        protected void _setEditable​(boolean b)
        Protected accessor to super.setEditable() that bypasses protected mode check

      • setEditable

        public void setEditable​(boolean b)
        Overrides:
        setEditable in class javax.swing.text.JTextComponent

      • setTouchscreenMode

        public void setTouchscreenMode​(int touchscreenMode)

      • getNonEditableBackground

        public java.awt.Color getNonEditableBackground()

      • setNonEditableBackground

        public void setNonEditableBackground​(java.awt.Color nonEditableBackground)

      • getEditableBackground

        public java.awt.Color getEditableBackground()

      • setEditableBackground

        public void setEditableBackground​(java.awt.Color editableBackground)

      • isOpaque

        public boolean isOpaque()
        Overrides:
        isOpaque in class javax.swing.JComponent

      • setVisible

        public void setVisible​(boolean visible)
        Overrides:
        setVisible in class javax.swing.JComponent

      • setPropertyValue

        public void setPropertyValue​(java.lang.String name,
                             java.lang.Object value)
                      throws java.lang.ClassCastException
        Specified by:
        setPropertyValue in interface DynamicPropertyProvider
        Throws:
        java.lang.ClassCastException

      • 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

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

      • paintChildren

        protected void paintChildren​(java.awt.Graphics g)
        Overrides:
        paintChildren in class javax.swing.JComponent

      • paintComponent

        protected void paintComponent​(java.awt.Graphics g)
        Overrides:
        paintComponent in class javax.swing.JComponent

      • 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

      • onStartup

        protected void onStartup()
        Subclasses should override this to provide startup logic.

      • onShutdown

        protected void onShutdown()
        Subclasses should override this to provide shutdown logic.

      • setToolTipText

        public void setToolTipText​(java.lang.String text)
        Overrides:
        setToolTipText in class javax.swing.JComponent