org.compiere.swing
Class CTextArea

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JScrollPane
                  org.compiere.swing.CTextArea

All Implemented Interfaces:

FocusListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ScrollPaneConstants, CEditor, PublishInterface

Direct Known Subclasses:

VMemo, VText

public class CTextArea
extends JScrollPane
implements CEditor, FocusListener, PublishInterface

Compiere TextArea - A ScrollPane with a JTextArea. Manages visibility, opaque and color consistently

Version:

$Id: CTextArea.java,v 1.3 2006/07/30 00:52:24 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Nested Class Summary

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

JScrollPane.AccessibleJScrollPane, JScrollPane.ScrollBar

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 javax.swing.JScrollPane

columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

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 javax.swing.ScrollPaneConstants

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

CTextArea()
Constructs a new TextArea.

CTextArea(Document doc)
Constructs a new JTextArea with the given document model, and defaults for all of the other arguments (null, 0, 0).

CTextArea(Document doc, String text, int rows, int columns)
Constructs a new JTextArea with the specified number of rows and columns, and the given model.

CTextArea(int rows, int columns)
Constructs a new empty TextArea with the specified number of rows and columns.

CTextArea(JTextArea textArea)
Create a JScrollArea with a JTextArea.

CTextArea(String text)
Constructs a new TextArea with the specified text displayed.

CTextArea(String text, int rows, int columns)
Constructs a new TextArea with the specified text and number of rows and columns.

Method Summary

void	addFocusListener(FocusListener l) AddFocusListener
void	addInputMethodListener(InputMethodListener l) Add Text Input Method Listener
void	addKeyListener(KeyListener l) Add Text Key Listener
void	addMouseListener(MouseListener l) Add Text Mouse Listener
void	addText(String text) Add Text (in New Line)
void	append(String text) Append text
void	focusGained(FocusEvent fe) Focus Listener - Gained
void	focusLost(FocusEvent fe) Focus Listener - Lost
Color	getBackground() Get Background color
int	getCaretPosition() Get Text Caret Position
int	getColumns() Get Columns
String	getDisplay() Return Display Value
Component	getFocusableComponent() Get Focus Component
Color	getForeground() Get Foreground color
InputMethodRequests	getInputMethodRequests() Get text Input Method Requests
int	getRows() Get Rows
String	getText() Get Text
JTextArea	getTextArea()
Object	getValue() Return Editor value
void	initPublish() Initialize Publishing
boolean	isEditable() Is Text Editable
boolean	isMandatory() Is Field mandatory
boolean	isReadWrite() Is it possible to edit
void	publish(Level level, String info, int step, int totalSteps) Publish Information to User.
void	requestFocus() Request Focus
boolean	requestFocusInWindow() Request Focus In Window
void	setBackground(boolean error) Set Background based on editable / mandatory / error
void	setBackground(Color color) Set Background color
void	setCaretPosition(int pos) Set Text Caret Position
void	setColumns(int cols) Set Columns
void	setEditable(boolean edit) Set Text Editable
void	setForeground(Color color) Set Foreground color
void	setInputVerifier(InputVerifier l) Set Text Input Verifier
void	setLineWrap(boolean wrap) Set Text Line Wrap
void	setMandatory(boolean mandatory) Set Editor Mandatory
void	setMargin(Insets m) Set Text Margin
void	setOpaque(boolean isOpaque) Set Opaque
void	setReadWrite(boolean rw) Enable Editor
void	setRows(int rows) Set Rows
void	setText(String text) Set Text and position top
void	setValue(Object value) Set Editor to value
void	setWrapStyleWord(boolean word) Set Text Wrap Style Word

Methods inherited from class javax.swing.JScrollPane

createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, 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, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setInheritsPopupMenu, setInputMap, setMaximumSize, setMinimumSize, setNextFocusableComponent, 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addHierarchyBoundsListener, addHierarchyListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, 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, processInputMethodEvent, 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

Methods inherited from interface org.compiere.swing.CEditor

setVisible

Constructor Detail

CTextArea

public CTextArea()

Constructs a new TextArea. A default model is set, the initial string is null, and rows/columns are set to 0.

CTextArea

public CTextArea(String text)

Constructs a new TextArea with the specified text displayed. A default model is created and rows/columns are set to 0.

Parameters:

text - the text to be displayed, or null

CTextArea

public CTextArea(int rows,
                 int columns)

Constructs a new empty TextArea with the specified number of rows and columns. A default model is created, and the initial string is null.

Parameters:

rows - the number of rows >= 0

columns - the number of columns >= 0

Throws:

IllegalArgumentException - if the rows or columns arguments are negative.

CTextArea

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

Constructs a new TextArea with the specified text and number of rows and columns. A default model is created.

Parameters:

text - the text to be displayed, or null

rows - the number of rows >= 0

columns - the number of columns >= 0

Throws:

IllegalArgumentException - if the rows or columns arguments are negative.

CTextArea

public CTextArea(Document doc)

Constructs a new JTextArea with the given document model, and defaults for all of the other arguments (null, 0, 0).

Parameters:

doc - the model to use

CTextArea

public CTextArea(Document doc,
                 String text,
                 int rows,
                 int columns)

Constructs a new JTextArea with the specified number of rows and columns, and the given model. All of the constructors feed through this constructor.

Parameters:

doc - the model to use, or create a default one if null

text - the text to be displayed, null if none

rows - the number of rows >= 0

columns - the number of columns >= 0

Throws:

IllegalArgumentException - if the rows or columns arguments are negative.

CTextArea

public CTextArea(JTextArea textArea)

Create a JScrollArea with a JTextArea. (use Compiere Colors, Line wrap)

Parameters:

textArea -

Method Detail

setMandatory

public void setMandatory(boolean mandatory)

Set Editor Mandatory

Specified by:

setMandatory in interface CEditor

Parameters:

mandatory - true, if you have to enter data

isMandatory

public boolean isMandatory()

Is Field mandatory

Specified by:

isMandatory in interface CEditor

Returns:

true, if mandatory

setReadWrite

public void setReadWrite(boolean rw)

Enable Editor

Specified by:

setReadWrite in interface CEditor

Parameters:

rw - true, if you can enter/select data

isReadWrite

public boolean isReadWrite()

Is it possible to edit

Specified by:

isReadWrite in interface CEditor

Returns:

true, if editable

setBackground

public void setBackground(boolean error)

Set Background based on editable / mandatory / error

Specified by:

setBackground in interface CEditor

Parameters:

error - if true, set background to error color, otherwise mandatory/editable

setBackground

public void setBackground(Color color)

Set Background color

Overrides:

setBackground in class JComponent

Parameters:

color - color

getBackground

public Color getBackground()

Get Background color

Overrides:

getBackground in class Component

Returns:

background

setForeground

public void setForeground(Color color)

Set Foreground color

Overrides:

setForeground in class JComponent

Parameters:

color -

getForeground

public Color getForeground()

Get Foreground color

Overrides:

getForeground in class Component

Returns:

color

setValue

public void setValue(Object value)

Set Editor to value

Specified by:

setValue in interface CEditor

Parameters:

value - value of the editor

getValue

public Object getValue()

Return Editor value

Specified by:

getValue in interface CEditor

Returns:

current value

getDisplay

public String getDisplay()

Return Display Value

Specified by:

getDisplay in interface CEditor

Returns:

displayed String value

setText

public void setText(String text)

Set Text and position top

Parameters:

text -

getText

public String getText()

Get Text

Returns:

text

append

public void append(String text)

Append text

Parameters:

text -

addText

public void addText(String text)

Add Text (in New Line)

Parameters:

text - text to be added

setColumns

public void setColumns(int cols)

Set Columns

Parameters:

cols -

getColumns

public int getColumns()

Get Columns

Returns:

columns

setRows

public void setRows(int rows)

Set Rows

Parameters:

rows -

getRows

public int getRows()

Get Rows

Returns:

rows

setCaretPosition

public void setCaretPosition(int pos)

Set Text Caret Position

Parameters:

pos -

getCaretPosition

public int getCaretPosition()

Get Text Caret Position

Returns:

position

setEditable

public void setEditable(boolean edit)

Set Text Editable

Parameters:

edit -

isEditable

public boolean isEditable()

Is Text Editable

Returns:

true if editable

setLineWrap

public void setLineWrap(boolean wrap)

Set Text Line Wrap

Parameters:

wrap -

setWrapStyleWord

public void setWrapStyleWord(boolean word)

Set Text Wrap Style Word

Parameters:

word -

setOpaque

public void setOpaque(boolean isOpaque)

Set Opaque

Overrides:

setOpaque in class JComponent

Parameters:

isOpaque -

setMargin

public void setMargin(Insets m)

Set Text Margin

Parameters:

m - insets

addFocusListener

public void addFocusListener(FocusListener l)

AddFocusListener

Overrides:

addFocusListener in class Component

Parameters:

l -

addMouseListener

public void addMouseListener(MouseListener l)

Add Text Mouse Listener

Overrides:

addMouseListener in class Component

Parameters:

l -

addKeyListener

public void addKeyListener(KeyListener l)

Add Text Key Listener

Overrides:

addKeyListener in class Component

Parameters:

l -

addInputMethodListener

public void addInputMethodListener(InputMethodListener l)

Add Text Input Method Listener

Overrides:

addInputMethodListener in class Component

Parameters:

l -

getInputMethodRequests

public InputMethodRequests getInputMethodRequests()

Get text Input Method Requests

Overrides:

getInputMethodRequests in class Component

Returns:

requests

setInputVerifier

public void setInputVerifier(InputVerifier l)

Set Text Input Verifier

Overrides:

setInputVerifier in class JComponent

Parameters:

l -

requestFocus

public void requestFocus()

Request Focus

Overrides:

requestFocus in class JComponent

requestFocusInWindow

public boolean requestFocusInWindow()

Request Focus In Window

Overrides:

requestFocusInWindow in class JComponent

Returns:

focus request

getFocusableComponent

public Component getFocusableComponent()

Get Focus Component

Returns:

component

initPublish

public void initPublish()

Initialize Publishing

Specified by:

initPublish in interface PublishInterface

publish

public void publish(Level level,
                    String info,
                    int step,
                    int totalSteps)

Publish Information to User.

Specified by:

publish in interface PublishInterface

Parameters:

level - type/importance - use INFO for main task - Create Database -- CONFIG for areas - (not used for this example) --- FINE for the actual work - Drop User ---- FINER for trace - database feedback * WARNING if we can continue * SEVERE if we need to abort the process

info - the clear text info

step - the step you are on

totalSteps - the total number of steps for this task

focusGained

public void focusGained(FocusEvent fe)

Focus Listener - Gained

Specified by:

focusGained in interface FocusListener

Parameters:

fe - event

focusLost

public void focusLost(FocusEvent fe)

Focus Listener - Lost

Specified by:

focusLost in interface FocusListener

Parameters:

fe - event

getTextArea

public JTextArea getTextArea()