arlut.csd.JDataComponent
Class JstringField

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent
                          |
                          +--javax.swing.JTextField
                                |
                                +--arlut.csd.JDataComponent.JentryField
                                      |
                                      +--arlut.csd.JDataComponent.JstringField

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.Scrollable, java.io.Serializable, javax.swing.SwingConstants

public class JstringField

extends JentryField

This class defines an entry field that is capable of handling strings. It is also possible to restrict the characters which are accepted by this gui component. Furthermore, the maximum size of the string that can be entered into this JstringField can be preset.

See Also:

Serialized Form

Field Summary

private java.lang.String	allowedChars
static boolean	debug
static int	DEFAULT_COLS
static int	DEFAULT_SIZE
private java.lang.String	disallowedChars
private boolean	processingCallback
private int	size
private java.lang.String	value

Fields inherited from class arlut.csd.JDataComponent.JentryField

allowCallback, my_parent, notifier

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

accessibleContext, 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.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

JstringField()
Constructor which uses default fonts,no parent, default column size, and default foregound/background colors.

JstringField(int cols, boolean is_editable)
Simple constructor.

JstringField(int columns, int maxstrlen, boolean is_editable, boolean invisible, java.lang.String allowed, java.lang.String disallowed)
Base constructor for JstringField

JstringField(int cols, int maxstrlen, boolean is_editable, boolean invisible, java.lang.String allowed, java.lang.String disallowed, arlut.csd.JDataComponent.JsetValueCallback callback)
Constructor that allows for the creation of a JstringField that knows about its parent.

Method Summary

java.lang.String	getAllowedChars() returns the set of allowed characters as a String object
char	getCharAt(int n) returns the character located at position n in the JstringField value
java.lang.String	getDisallowedChars() returns the set of disallowed characters as a String object
int	getLength() returns the current size of the contents of this gui field
int	getMaxStringSize() returns the maximum size of the string that can be placed in this JstringField
java.lang.String	getValue() Return the string contained in this field, whether it has been validated in a callback or not.
boolean	isAllowed(char ch) determines whether a given character is valid or invalid for a JstringField The JentryDocument object for this field will use this method to allow or disallow the character ch from being added.
int	sendCallback() sendCallback is called when focus is lost, or when we are otherwise triggered.
void	setAllowedChars(java.lang.String s) assigns a set of characters which are valid within the JstringField
void	setDisallowedChars(java.lang.String s) assigns a set of characters which are invalid within the JstringField
void	setText(java.lang.String str) sets the JstringField to a specific value
private void	verifyValue(java.lang.String str) Checks the entire string str for compliance with this field's constraints.

Methods inherited from class arlut.csd.JDataComponent.JentryField

actionPerformed, focusGained, focusLost, setCallback, setEnterHandler

Methods inherited from class javax.swing.JTextField

addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

debug

public static final boolean debug

See Also:

Constant Field Values

DEFAULT_COLS

public static int DEFAULT_COLS

DEFAULT_SIZE

public static int DEFAULT_SIZE

size

private int size

value

private java.lang.String value

allowedChars

private java.lang.String allowedChars

disallowedChars

private java.lang.String disallowedChars

processingCallback

private boolean processingCallback

Constructor Detail

JstringField

public JstringField(int columns,
                    int maxstrlen,
                    boolean is_editable,
                    boolean invisible,
                    java.lang.String allowed,
                    java.lang.String disallowed)

Base constructor for JstringField

Parameters:

columns - number of colums in the JstringField

is_editable - true if this JstringField is editable

JstringField

public JstringField()

Constructor which uses default fonts,no parent, default column size, and default foregound/background colors.

JstringField

public JstringField(int cols,
                    boolean is_editable)

Simple constructor.

JstringField

public JstringField(int cols,
                    int maxstrlen,
                    boolean is_editable,
                    boolean invisible,
                    java.lang.String allowed,
                    java.lang.String disallowed,
                    arlut.csd.JDataComponent.JsetValueCallback callback)

Constructor that allows for the creation of a JstringField that knows about its parent.

Parameters:

cols - number of colums in the JstringField

Method Detail

setText

public void setText(java.lang.String str)

sets the JstringField to a specific value

Overrides:

setText in class javax.swing.text.JTextComponent

Parameters:

str - value to which the JstringField is set

verifyValue

private void verifyValue(java.lang.String str)

Checks the entire string str for compliance with this field's constraints. Throws an IllegalArgumentException if the provided string is not acceptable.

getValue

public java.lang.String getValue()

Return the string contained in this field, whether it has been validated in a callback or not.

getCharAt

public char getCharAt(int n)

returns the character located at position n in the JstringField value

Parameters:

n - position in the JstringField value from which to retrieve character

setAllowedChars

public void setAllowedChars(java.lang.String s)

assigns a set of characters which are valid within the JstringField

Parameters:

s - each character in this string will be considered an allowed character

setDisallowedChars

public void setDisallowedChars(java.lang.String s)

assigns a set of characters which are invalid within the JstringField

Parameters:

s - each character in this string will be considered a disallowed character

getAllowedChars

public java.lang.String getAllowedChars()

returns the set of allowed characters as a String object

getDisallowedChars

public java.lang.String getDisallowedChars()

returns the set of disallowed characters as a String object

getMaxStringSize

public int getMaxStringSize()

returns the maximum size of the string that can be placed in this JstringField

Overrides:

getMaxStringSize in class JentryField

getLength

public int getLength()

returns the current size of the contents of this gui field

Overrides:

getLength in class JentryField

isAllowed

public boolean isAllowed(char ch)

determines whether a given character is valid or invalid for a JstringField The JentryDocument object for this field will use this method to allow or disallow the character ch from being added.

Overrides:

isAllowed in class JentryField

Parameters:

ch - the character which is being tested for its validity

sendCallback

public int sendCallback()

sendCallback is called when focus is lost, or when we are otherwise triggered. A true value will be returned if the value change was approved and performed, or false if not. If the value did not change, this method will also return false.

Specified by:

sendCallback in class JentryField