Package adams.gui.core

Class BaseTextAreaWithButtons

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.core.BasePanelWithButtons

adams.gui.core.AbstractComponentWithButtons<BaseTextArea>

adams.gui.core.BaseTextAreaWithButtons

All Implemented Interfaces:

AnyChangeListenerSupporter, AppendableTextAreaComponent, BaseTextComponent, TextAreaComponent, ImageObserver, MenuContainer, Serializable, Accessible

public class BaseTextAreaWithButtons
extends AbstractComponentWithButtons<BaseTextArea>
implements AppendableTextAreaComponent, AnyChangeListenerSupporter

Graphical component that consists of a BaseTable with buttons on the right-hand side.

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 inherited from class adams.gui.core.AbstractComponentWithButtons

m_Component, m_LabelInfo, m_PanelAll, m_PanelInfo, m_ScrollPane

Fields inherited from class adams.gui.core.BasePanelWithButtons

m_LayoutButtons, m_PanelButtons

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
BaseTextAreaWithButtons()	The default constructor.
BaseTextAreaWithButtons(int rows, int columns)	Initializes the list with the given rows/columns.
BaseTextAreaWithButtons(String text)	Initializes the list with the given text.
BaseTextAreaWithButtons(String text, int rows, int columns)	Initializes the list with the given text.

Method Summary

Modifier and Type	Method	Description
void	addAnyChangeListener(ChangeListener l)	Adds the listener for listening to any text changes.
void	append(String text)	Appends the given text to the end of the document.
BaseTextArea	createComponent()	Returns the underlying text area.
int	getCaretPosition()	Returns the current caret position.
int	getColumns()	Returns the columns.
Document	getDocument()	Returns the underlying document.
boolean	getLineWrap()	Returns whether line wrap is enabled.
int	getRows()	Returns the rows.
String	getSelectedText()	Returns the underlying text.
String	getText()	Returns the underlying text.
Font	getTextFont()	Returns the text font in use.
boolean	getWrapStyleWord()	Returns whether word wrap is enabled.
boolean	isEditable()	Returns whether the text area is editable or not.
void	removeAnyChangeListener(ChangeListener l)	Removes the listener from listening to any text changes.
boolean	requiresScrollPane()	Returns whether the component requires a JScrollPane around it.
void	setCaretPosition(int pos)	Sets the caret position.
void	setCaretPositionLast()	Sets the position of the cursor at the end.
void	setColumns(int value)	Sets the columns.
void	setEditable(boolean value)	Sets whether the text area is editable or not.
void	setLineWrap(boolean value)	Sets whether to line wrap or not.
void	setRows(int value)	Sets the rows.
void	setText(String value)	Sets the text.
void	setTextFont(Font value)	Sets the text font.
void	setWrapStyleWord(boolean value)	Sets whether to word wrap or not.

Methods inherited from class adams.gui.core.AbstractComponentWithButtons

addKeyListener, getComponent, getScrollPane, initGUI, isInfoVisible, removeKeyListener, setInfoVisible, updateInfo

Methods inherited from class adams.gui.core.BasePanelWithButtons

addToButtonsPanel, clearButtonsPanel, removeFromButtonsPanel

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, 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, 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

Constructor Detail

BaseTextAreaWithButtons

public BaseTextAreaWithButtons()

The default constructor.

BaseTextAreaWithButtons

public BaseTextAreaWithButtons(String text)

Initializes the list with the given text.

Parameters:

text - the text to use

BaseTextAreaWithButtons

public BaseTextAreaWithButtons(int rows,
                               int columns)

Initializes the list with the given rows/columns.

Parameters:

rows - the rows to use

columns - the columns to use

BaseTextAreaWithButtons

public BaseTextAreaWithButtons(String text,
                               int rows,
                               int columns)

Initializes the list with the given text.

Parameters:

text - the text to use

rows - the rows to use

columns - the columns to use

Method Detail

requiresScrollPane

public boolean requiresScrollPane()

Returns whether the component requires a JScrollPane around it.

Specified by:

requiresScrollPane in class AbstractComponentWithButtons<BaseTextArea>

Returns:

true if the component requires a JScrollPane

createComponent

public BaseTextArea createComponent()

Returns the underlying text area.

Specified by:

createComponent in class AbstractComponentWithButtons<BaseTextArea>

Returns:

the underlying text area

getDocument

public Document getDocument()

Returns the underlying document.

Specified by:

getDocument in interface TextAreaComponent

Returns:

the document

setText

public void setText(String value)

Sets the text.

Specified by:

setText in interface BaseTextComponent

Specified by:

setText in interface TextAreaComponent

Parameters:

value - the text to display

getText

public String getText()

Returns the underlying text.

Specified by:

getText in interface BaseTextComponent

Specified by:

getText in interface TextAreaComponent

Returns:

the underlying text

getSelectedText

public String getSelectedText()

Returns the underlying text.

Specified by:

getSelectedText in interface TextAreaComponent

Returns:

the underlying text

setRows

public void setRows(int value)

Sets the rows.

Specified by:

setRows in interface TextAreaComponent

Parameters:

value - the rows

getRows

public int getRows()

Returns the rows.

Specified by:

getRows in interface TextAreaComponent

Returns:

the rows

setColumns

public void setColumns(int value)

Sets the columns.

Specified by:

setColumns in interface TextAreaComponent

Parameters:

value - the columns

getColumns

public int getColumns()

Returns the columns.

Specified by:

getColumns in interface TextAreaComponent

Returns:

the columns

setEditable

public void setEditable(boolean value)

Sets whether the text area is editable or not.

Specified by:

setEditable in interface TextAreaComponent

Parameters:

value - if true the text area is editable

isEditable

public boolean isEditable()

Returns whether the text area is editable or not.

Specified by:

isEditable in interface TextAreaComponent

Returns:

true if the text area is editable

setLineWrap

public void setLineWrap(boolean value)

Sets whether to line wrap or not.

Specified by:

setLineWrap in interface TextAreaComponent

Parameters:

value - if true line wrap is enabled

getLineWrap

public boolean getLineWrap()

Returns whether line wrap is enabled.

Specified by:

getLineWrap in interface TextAreaComponent

Returns:

true if line wrap wrap is enabled

setWrapStyleWord

public void setWrapStyleWord(boolean value)

Sets whether to word wrap or not.

Specified by:

setWrapStyleWord in interface TextAreaComponent

Parameters:

value - if true word wrap is enabled

getWrapStyleWord

public boolean getWrapStyleWord()

Returns whether word wrap is enabled.

Specified by:

getWrapStyleWord in interface TextAreaComponent

Returns:

true if word wrap wrap is enabled

setTextFont

public void setTextFont(Font value)

Sets the text font.

Specified by:

setTextFont in interface TextAreaComponent

Parameters:

value - the font

getTextFont

public Font getTextFont()

Returns the text font in use.

Specified by:

getTextFont in interface TextAreaComponent

Returns:

the font

setCaretPosition

public void setCaretPosition(int pos)

Sets the caret position.

Specified by:

setCaretPosition in interface TextAreaComponent

Parameters:

pos - the position (0-based)

getCaretPosition

public int getCaretPosition()

Returns the current caret position.

Specified by:

getCaretPosition in interface TextAreaComponent

Returns:

the position (0-based)

setCaretPositionLast

public void setCaretPositionLast()

Sets the position of the cursor at the end.

Specified by:

setCaretPositionLast in interface TextAreaComponent

append

public void append(String text)

Appends the given text to the end of the document. Does nothing if the model is null or the string is null or empty.

Specified by:

append in interface AppendableTextAreaComponent

Parameters:

text - the text to insert

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