Package adams.gui.core

Class BaseTextFieldWithButtons

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.core.BaseTextFieldWithButtons

All Implemented Interfaces:

AnyChangeListenerSupporter, BaseTextComponent, ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

BaseTextFieldWithCopyPasteButtons

public class BaseTextFieldWithButtons
extends BasePanel
implements AnyChangeListenerSupporter, BaseTextComponent

BaseTextFieldWithButtons with additional support for buttons.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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 BaseTextField	m_Component	the underlying text field.
protected GridLayout	m_LayoutButtons	the layout for the buttons.
protected BasePanel	m_PanelButtons	the panel with the buttons (on the right).

Fields inherited from class adams.gui.core.BasePanel

m_FileChooser

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

Constructor Summary

Constructors

Constructor	Description
BaseTextFieldWithButtons()	The default constructor.
BaseTextFieldWithButtons(int columns)	Constructs a new empty TextField with the specified number of columns.
BaseTextFieldWithButtons(String text)	Initializes the list with the given text.
BaseTextFieldWithButtons(String text, int columns)	Constructs a new TextField initialized with the specified text and columns.

Method Summary

Modifier and Type	Method	Description
void	addAnyChangeListener(ChangeListener l)	Adds the listener for listening to any text changes.
void	addToButtonsPanel(Component comp)	Adds the component to the panel with the buttons.
int	getCaretPosition()	Returns the current caret position.
int	getColumns()	Returns the number of columns in this TextField.
BaseTextField	getComponent()	Returns the underlying text field.
Document	getDocument()	Returns the underlying document.
String	getSelectedText()	Returns the underlying text.
String	getText()	Returns the underlying text.
Font	getTextFont()	Returns the text font in use.
protected void	initGUI()	Initializes the widgets.
boolean	isEditable()	Returns whether the text area is editable or not.
void	removeAnyChangeListener(ChangeListener l)	Removes the listener from listening to any text changes.
void	removeFromButtonsPanel(Component comp)	Removes the component from the panel with the buttons.
void	setCaretPosition(int pos)	Sets the caret position.
void	setColumns(int value)	Sets the number of columns in this TextField, and then invalidate the layout.
void	setEditable(boolean value)	Sets whether the text area is editable or not.
void	setText(String value)	Sets the text.
void	setTextFont(Font value)	Sets the text font.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initFileChooser, initialize, main, printErrorMessage, printException, saveComponent, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, 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, addInputMethodListener, 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, getInputMethodRequests, 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, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, 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

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

Field Detail

m_Component

protected BaseTextField m_Component

the underlying text field.

m_LayoutButtons

protected GridLayout m_LayoutButtons

the layout for the buttons.

m_PanelButtons

protected BasePanel m_PanelButtons

the panel with the buttons (on the right).

Constructor Detail

BaseTextFieldWithButtons

public BaseTextFieldWithButtons()

The default constructor.

BaseTextFieldWithButtons

public BaseTextFieldWithButtons(String text)

Initializes the list with the given text.

Parameters:

text - the text to use

BaseTextFieldWithButtons

public BaseTextFieldWithButtons(int columns)

Constructs a new empty TextField with the specified number of columns. A default model is created and the initial string is set to null.

Parameters:

columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation

BaseTextFieldWithButtons

public BaseTextFieldWithButtons(String text,
                                int columns)

Constructs a new TextField initialized with the specified text and columns. A default model is created.

Parameters:

text - the text to be displayed, or null

columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation

Method Detail

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BasePanel

addToButtonsPanel

public void addToButtonsPanel(Component comp)

Adds the component to the panel with the buttons.

Parameters:

comp - the component to add

removeFromButtonsPanel

public void removeFromButtonsPanel(Component comp)

Removes the component from the panel with the buttons.

Parameters:

comp - the component to remove

getComponent

public BaseTextField getComponent()

Returns the underlying text field.

Returns:

the text field

getDocument

public Document getDocument()

Returns the underlying document.

Returns:

the document

setText

public void setText(String value)

Sets the text.

Specified by:

setText in interface BaseTextComponent

Parameters:

value - the text to display

getText

public String getText()

Returns the underlying text.

Specified by:

getText in interface BaseTextComponent

Returns:

the underlying text

getSelectedText

public String getSelectedText()

Returns the underlying text.

Returns:

the underlying text

setColumns

public void setColumns(int value)

Sets the number of columns in this TextField, and then invalidate the layout.

Parameters:

value - the number of columns >= 0

Throws:

IllegalArgumentException - if columns is less than 0

getColumns

public int getColumns()

Returns the number of columns in this TextField.

Returns:

the number of columns >= 0

setEditable

public void setEditable(boolean value)

Sets whether the text area is editable or not.

Parameters:

value - if true the text area is editable

isEditable

public boolean isEditable()

Returns whether the text area is editable or not.

Returns:

true if the text area is editable

setTextFont

public void setTextFont(Font value)

Sets the text font.

Parameters:

value - the font

getTextFont

public Font getTextFont()

Returns the text font in use.

Returns:

the font

setCaretPosition

public void setCaretPosition(int pos)

Sets the caret position.

Parameters:

pos - the position (0-based)

getCaretPosition

public int getCaretPosition()

Returns the current caret position.

Returns:

the position (0-based)

addAnyChangeListener

public void addAnyChangeListener(ChangeListener l)

Adds the listener for listening to any text changes.

Specified by:

addAnyChangeListener in interface AnyChangeListenerSupporter

Parameters:

l - the listener to add

removeAnyChangeListener

public void removeAnyChangeListener(ChangeListener l)

Removes the listener from listening to any text changes.

Specified by:

removeAnyChangeListener in interface AnyChangeListenerSupporter

Parameters:

l - the listener to remove