Package HAL.Gui

Class UIStringInput

  • All Implemented Interfaces:
    GuiComp, MenuItem, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants

    public class UIStringInput
    extends javax.swing.JTextField
    implements MenuItem, GuiComp
    a menu item that takes string input
    See Also:
    Serialized Form
    • Nested Class Summary

      • 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.Component

        java.awt.Component.BaselineResizeBehavior
    • Field Summary

      Fields 
      Modifier and Type Field Description
      javax.swing.JLabel label  
      • 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

        TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
      • Fields inherited from class java.awt.Component

        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
    • Constructor Summary

      Constructors 
      Constructor Description
      UIStringInput​(java.lang.String label, int nCols, java.lang.String initVal)  
      UIStringInput​(java.lang.String label, java.lang.String initVal)  
      UIStringInput​(java.lang.String label, java.lang.String initVal, int nCols, int compX, int compY)  
    • Method Summary

      Modifier and Type Method Description
      void _GetComps​(java.util.ArrayList<java.awt.Component> putHere, java.util.ArrayList<java.lang.Integer> coordsHere, java.util.ArrayList<java.lang.Integer> compSizesHere)
      ignore
      java.lang.String _GetInitValue()  
      int compX()
      ignore
      int compY()
      ignore
      java.lang.String Get()
      ignore
      <T extends java.awt.Component>
      T
      GetEntry​(int iEntry)
      ignore
      java.lang.String GetLabel()
      ignore
      boolean IsActive()  
      int NEntries()
      ignore
      void Set​(java.lang.String val)
      ignore
      void SetActive​(boolean isActive)  
      UIStringInput SetColor​(int foregroundColor, int backgroundColor)  
      UIStringInput SetColor​(java.awt.Color foregroundColor, java.awt.Color backgroundColor)
      sets the foreground and background of the UIStringInput
      int TypeID()
      ignore
      • Methods inherited from class javax.swing.JTextField

        addActionListener, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset
      • Methods inherited from class javax.swing.text.JTextComponent

        addCaretListener, addInputMethodListener, addKeymap, copy, cut, 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, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, 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, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isPaintingTile, isRequestFocusEnabled, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, 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

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • label

        public javax.swing.JLabel label
    • Constructor Detail

      • UIStringInput

        public UIStringInput​(java.lang.String label,
                             java.lang.String initVal,
                             int nCols,
                             int compX,
                             int compY)
        Parameters:
        label - the label of the menuString
        initVal - the starting value of the menuString
        nCols - the number of characters that will fit on the display
        compX - the width on the gui GridBagLayout
        compY - the height on the gui GridBagLayout
      • UIStringInput

        public UIStringInput​(java.lang.String label,
                             int nCols,
                             java.lang.String initVal)
      • UIStringInput

        public UIStringInput​(java.lang.String label,
                             java.lang.String initVal)
        Parameters:
        label - the label of the menuString
        initVal - the starting value of the menuString
    • Method Detail

      • SetColor

        public UIStringInput SetColor​(java.awt.Color foregroundColor,
                                      java.awt.Color backgroundColor)
        sets the foreground and background of the UIStringInput
        Parameters:
        foregroundColor - color of the text if null the UIWindow color will be used
        backgroundColor - color of the background, if null the UIWindow color will be used
      • SetColor

        public UIStringInput SetColor​(int foregroundColor,
                                      int backgroundColor)
      • TypeID

        public int TypeID()
        ignore
        Specified by:
        TypeID in interface MenuItem
      • Set

        public void Set​(java.lang.String val)
        ignore
        Specified by:
        Set in interface MenuItem
      • Get

        public java.lang.String Get()
        ignore
        Specified by:
        Get in interface MenuItem
      • GetLabel

        public java.lang.String GetLabel()
        ignore
        Specified by:
        GetLabel in interface MenuItem
      • NEntries

        public int NEntries()
        ignore
        Specified by:
        NEntries in interface MenuItem
      • GetEntry

        public <T extends java.awt.Component> T GetEntry​(int iEntry)
        ignore
        Specified by:
        GetEntry in interface MenuItem
      • _GetInitValue

        public java.lang.String _GetInitValue()
        Specified by:
        _GetInitValue in interface MenuItem
      • compX

        public int compX()
        ignore
        Specified by:
        compX in interface GuiComp
      • compY

        public int compY()
        ignore
        Specified by:
        compY in interface GuiComp
      • IsActive

        public boolean IsActive()
        Specified by:
        IsActive in interface GuiComp
      • SetActive

        public void SetActive​(boolean isActive)
        Specified by:
        SetActive in interface GuiComp
      • _GetComps

        public void _GetComps​(java.util.ArrayList<java.awt.Component> putHere,
                              java.util.ArrayList<java.lang.Integer> coordsHere,
                              java.util.ArrayList<java.lang.Integer> compSizesHere)
        ignore
        Specified by:
        _GetComps in interface GuiComp