DESY ACOP Beans Home

com.cosylab.gui.components
Class ReportTextArea

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent
                  javax.swing.JTextArea
                      com.cosylab.gui.components.ReportTextArea

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

public class ReportTextArea
extends javax.swing.JTextArea

An extension of the JTextArea providing features commonly needed when using a text area to report large amounts of information to the screen.

Version:

$id$

Author:

Miha Kadunc

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JTextArea.AccessibleJTextArea

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

Constructor Summary

ReportTextArea()
Constructs an empty ReportTextArea.

ReportTextArea(javax.swing.text.Document doc)
Constructs a new ReportTextArea with the specified document.

ReportTextArea(javax.swing.text.Document doc, java.lang.String text, int rows, int columns)
Constructs a new ReportTextArea with the specified document, text, and number of rows and columns.

ReportTextArea(int rows, int columns)
Constructs a text area with the specified number of rows and columns.

ReportTextArea(java.lang.String text)
Constructs a ReportTextArea containing the specified text.

ReportTextArea(java.lang.String text, int rows, int columns)
Constructs a ReportTextArea containing the specified text and number of rows and columns.

Method Summary

void	append(java.lang.String text) Appends a string to the end of the text area.
void	append(java.lang.String text, javax.swing.text.AttributeSet style) Appends a string to the end of the text area with ginven text style.
javax.swing.JFileChooser	getFileChooser() Returns the JFileChooser that this component uses to save the text to a file.
int	getMaxLines() Returns the maximum number of lines that this text area displays when autoCut property is set to true
void	insert(java.lang.String text, int pos) Inserts text to this text area at the specified index.
boolean	isAutoCut() When autoCut property is set to true, the component automatically cuts the beginning of text when it contains more lines than specified by the maxLines property.
boolean	isAutoScroll() Returns the value of the autoScroll property.
static void	main(java.lang.String[] args) main entrypoint - starts the part when it is run as an application
void	saveTextToFile() Shows a dialog to prompt the user for a fileName and saves the text to a file specified by the user.
void	setAutoCut(boolean newAutocut) Sets the autoCut property.
void	setAutoScroll(boolean newAutoScroll) Sets the value of the autoScroll property.
void	setFileChooser(javax.swing.JFileChooser newFileChooser) Sets the JFileChooser that this component should use when saving text to a file.
void	setMaxLines(int newMaxLines) Sets the maxLines property.
void	setText(java.lang.String t)

Methods inherited from class javax.swing.JTextArea

createDefaultModel, getAccessibleContext, getColumns, getColumnWidth, getLineCount, getLineEndOffset, getLineOfOffset, getLineStartOffset, getLineWrap, getPreferredScrollableViewportSize, getPreferredSize, getRowHeight, getRows, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getTabSize, getUIClassID, getWrapStyleWord, paramString, replaceRange, setColumns, setFont, setLineWrap, setRows, setTabSize, setWrapStyleWord

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDocument, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, 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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, 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, 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, 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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

Constructor Detail

ReportTextArea

public ReportTextArea()

Constructs an empty ReportTextArea.

ReportTextArea

public ReportTextArea(int rows,
                      int columns)

Constructs a text area with the specified number of rows and columns.

Parameters:

rows - int

columns - int

ReportTextArea

public ReportTextArea(java.lang.String text)

Constructs a ReportTextArea containing the specified text.

Parameters:

text - java.lang.String

ReportTextArea

public ReportTextArea(java.lang.String text,
                      int rows,
                      int columns)

Constructs a ReportTextArea containing the specified text and number of rows and columns.

Parameters:

text - java.lang.String

rows - int

columns - int

ReportTextArea

public ReportTextArea(javax.swing.text.Document doc)

Constructs a new ReportTextArea with the specified document.

Parameters:

doc - javax.swing.text.Document

ReportTextArea

public ReportTextArea(javax.swing.text.Document doc,
                      java.lang.String text,
                      int rows,
                      int columns)

Constructs a new ReportTextArea with the specified document, text, and number of rows and columns.

Parameters:

doc - javax.swing.text.Document

text - java.lang.String

rows - int

columns - int

Method Detail

append

public void append(java.lang.String text)

Appends a string to the end of the text area.

Overrides:

append in class javax.swing.JTextArea

Parameters:

text - java.lang.String

append

public void append(java.lang.String text,
                   javax.swing.text.AttributeSet style)

Appends a string to the end of the text area with ginven text style.

Parameters:

text - appended text

style - a style of appended text

getFileChooser

public javax.swing.JFileChooser getFileChooser()

Returns the JFileChooser that this component uses to save the text to a file.

Returns:

javax.swing.JFileChooser

See Also:

saveTextToFile()

getMaxLines

public int getMaxLines()

Returns the maximum number of lines that this text area displays when autoCut property is set to true

Returns:

int

insert

public void insert(java.lang.String text,
                   int pos)

Inserts text to this text area at the specified index.

Overrides:

insert in class javax.swing.JTextArea

Parameters:

text - java.lang.String

pos - int

isAutoCut

public boolean isAutoCut()

When autoCut property is set to true, the component automatically cuts the beginning of text when it contains more lines than specified by the maxLines property.

Returns:

boolean

isAutoScroll

public boolean isAutoScroll()

Returns the value of the autoScroll property. This property determines whether the caret position should be moved to the end of the text when a string is appended to the text.

Returns:

boolean

main

public static void main(java.lang.String[] args)

main entrypoint - starts the part when it is run as an application

Parameters:

args - java.lang.String[]

saveTextToFile

public void saveTextToFile()

Shows a dialog to prompt the user for a fileName and saves the text to a file specified by the user.

setAutoCut

public void setAutoCut(boolean newAutocut)

Sets the autoCut property.

Parameters:

newAutocut - boolean

See Also:

isAutoCut()

setAutoScroll

public void setAutoScroll(boolean newAutoScroll)

Sets the value of the autoScroll property.

Parameters:

newAutoScroll - boolean

See Also:

isAutoScroll()

setFileChooser

public void setFileChooser(javax.swing.JFileChooser newFileChooser)

Sets the JFileChooser that this component should use when saving text to a file.

Parameters:

newFileChooser - javax.swing.JFileChooser

setMaxLines

public void setMaxLines(int newMaxLines)

Sets the maxLines property.

Parameters:

newMaxLines - int

setText

public void setText(java.lang.String t)

Overrides:

setText in class javax.swing.text.JTextComponent