org.PingOO.DLAI.lib.PWidget
Class PTextArea

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent
                          |
                          +--javax.swing.JTextArea
                                |
                                +--org.PingOO.DLAI.lib.PWidget.PTextArea

public class PTextArea
extends javax.swing.JTextArea
implements PComponent

Provides a text area that is localized tool tip capable.

There seems to be a bug somewhere in JTextArea as :

Since:
PingOO 2.0
Version:
2.0
Author:
Fabrice Bouyé (bouye@cur-archamps.fr)
See Also:
JTextArea, PComponent, Serialized Form

Inner classes inherited from class javax.swing.JTextArea
javax.swing.JTextArea.AccessibleJTextArea
 
Inner classes inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.ClipboardObserver, javax.swing.text.JTextComponent.ComposedTextCaret, javax.swing.text.JTextComponent.DefaultKeymap, javax.swing.text.JTextComponent.FocusAction, javax.swing.text.JTextComponent.InputMethodRequestsHandler, javax.swing.text.JTextComponent.KeyBinding, javax.swing.text.JTextComponent.MutableCaretEvent
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent, javax.swing.JComponent.IntVector, javax.swing.JComponent.KeyboardBinding, javax.swing.JComponent.KeyboardState
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AWTTreeLock
 
Field Summary
 java.awt.event.MouseListener defaultMouseListener
          Default mouse listener for editing operations.
private  PManager manager
          The manager where this component will lokk for its resources.
protected  java.lang.String module
          Defines the module where to find this internal text area's text and tool tip.
protected  java.lang.String toolTipKey
          Defines the key used to find this internal text area's tool tip.
 
Fields inherited from class javax.swing.JTextArea
columns, columnWidth, rowHeight, rows, uiClassID, word, wrap
 
Fields inherited from class javax.swing.text.JTextComponent
blinkRate, caret, caretColor, caretEvent, composedText, composedTextCaret, composedTextContent, composedTextEnd, composedTextStart, DEFAULT_KEYMAP, defaultBindings, defaultClipboardOwner, disabledTextColor, editable, editor, FOCUS_ACCELERATOR_KEY, focusAccelerator, focusAction, focusedComponent, highlighter, inputMethodRequestsHandler, keymap, keymapTable, margin, model, opaque, originalCaret, selectedTextColor, selectionColor
 
Fields inherited from class javax.swing.JComponent
_bounds, accessibleContext, alignmentX, alignmentY, ANCESTOR_USING_BUFFER, ancestorNotifier, autoscroller, border, changeSupport, clientProperties, flags, HAS_FOCUS, IS_DOUBLE_BUFFERED, IS_OPAQUE, IS_PAINTING_TILE, KEYBOARD_BINDINGS_KEY, listenerList, maximumSize, minimumSize, NEXT_FOCUS, paintImmediatelyClip, preferredSize, readObjectCallbacks, REQUEST_FOCUS_DISABLED, tmpRect, TOOL_TIP_TEXT_KEY, ui, uiClassID, UNDEFINED_CONDITION, vetoableChangeSupport, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
component, containerListener, containerSerializedDataVersion, dispatcher, layoutMgr, maxSize, ncomponents, serialVersionUID
 
Fields inherited from class java.awt.Component
actionListenerK, adjustmentListenerK, appContext, assert, background, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, changeSupport, componentListener, componentListenerK, componentOrientation, componentSerializedDataVersion, containerListenerK, cursor, dropTarget, enabled, eventMask, focusListener, focusListenerK, font, foreground, hasFocus, height, incRate, inputMethodListener, inputMethodListenerK, isInc, isPacked, itemListenerK, keyListener, keyListenerK, LEFT_ALIGNMENT, locale, LOCK, minSize, mouseListener, mouseListenerK, mouseMotionListener, mouseMotionListenerK, name, nameExplicitlySet, newEventsOnly, ownedWindowK, parent, peer, peerFont, popups, prefSize, RIGHT_ALIGNMENT, serialVersionUID, textListenerK, TOP_ALIGNMENT, valid, visible, width, windowListenerK, x, y
 
Constructor Summary
  PTextArea()
          Constructs a new text area.
(package private) PTextArea(javax.swing.text.Document doc)
          Constructs a new text area with the given document model, and defaults for all of the other arguments (null, 0, 0).
(package private) PTextArea(javax.swing.text.Document doc, java.lang.String text, int rows, int columns)
          Constructs a new text area with the specified number of rows and columns, and the given model.
(package private) PTextArea(int rows, int columns)
          Constructs a new empty TextArea with the specified number of rows and columns.
  PTextArea(java.lang.String toolTipKey)
          Creates a new text area with localized capabilities.
(package private) PTextArea(java.lang.String text, int rows, int columns)
          Constructs a new TextArea with the specified text and number of rows and columns.
  PTextArea(java.lang.String toolTipKey, java.lang.String module)
          Creates a new text area with localized capabilities.
  PTextArea(java.lang.String toolTipKey, java.lang.String module, javax.swing.text.Document doc, java.lang.String text, int rows, int columns)
          Creates a new text area with localized capabilities.
  PTextArea(java.lang.String toolTipKey, java.lang.String module, java.lang.String text)
          Creates a new text area with localized capabilities.
  PTextArea(java.lang.String toolTipKey, java.lang.String module, java.lang.String text, int rows, int columns)
          Creates a new text area with localized capabilities.
 
Method Summary
 PManager getManager()
          Returns the manager of this component.
 java.lang.String getModule()
          Returns the component's resources location.
 java.lang.String getTextKey()
          Returns the key used to find this component's text
 java.lang.String getToolTipKey()
          Returns the key used to find this internal text area's tool tip.
 void setLocalizedToolTipText(java.lang.String toolTipKey)
          Registers the text to display in a tool tip.
 void setManager(PManager manager)
          Sets the manager of this component.
 void setModule(java.lang.String module)
          Sets The module where the component will search its resources
 void updateFont()
          Update the component's font.
 void updateLanguage()
          Updates the language of the interface.
 void updateLanguage(java.lang.String module)
          Updates the language of the interface.
 
Methods inherited from class javax.swing.JTextArea
append, createDefaultModel, getAccessibleContext, getColumns, getColumnWidth, getLineCount, getLineEndOffset, getLineOfOffset, getLineStartOffset, getLineWrap, getPreferredScrollableViewportSize, getPreferredSize, getRowHeight, getRows, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getTabSize, getUIClassID, getWrapStyleWord, insert, isManagingFocus, paramString, processComponentKeyEvent, replaceRange, setColumns, setFont, setLineWrap, setRows, setTabSize, setWrapStyleWord, writeObject
 
Methods inherited from class javax.swing.text.JTextComponent
, addCaretListener, addKeymap, copy, createComposedString, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretPosition, getDisabledTextColor, getDocument, getFocusAccelerator, getFocusedComponent, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionEnd, getSelectionStart, getSelectionStart, getText, getText, getUI, isEditable, isFocusTraversable, isOpaque, loadKeymap, mapEventToAction, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, readObject, removeCaretListener, removeKeymap, removeNotify, replaceInputMethodText, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setEditable, setEnabled, setFocusAccelerator, setHighlighter, setInputMethodCaretPosition, setKeymap, setMargin, setOpaque, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write
 
Methods inherited from class javax.swing.JComponent
_paintImmediately, addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, adjustPaintFlags, alwaysOnTop, bindingForKeyStroke, computeVisibleRect, computeVisibleRect, contains, createToolTip, enableSerialization, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperties, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getFlag, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, keyboardBindings, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paintWithBuffer, processFocusEvent, processKeyBinding, processKeyBindings, processKeyBindingsForAllComponents, processKeyEvent, processMouseMotionEvent, putClientProperty, rectangleIsObscured, registerKeyboardAction, registerKeyboardAction, registerWithKeyboardManager, removeAncestorListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFlag, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, shouldDebugGraphics, superProcessMouseMotionEvent, unregisterKeyboardAction, unregisterWithKeyboardManager, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyOrientation, countComponents, deliverEvent, dispatchEventImpl, dispatchEventToSelf, doLayout, eventEnabled, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents_NoClientCode, getComponents, getLayout, getMouseEventTarget, getWindow, initIDs, insets, invalidate, invalidateTree, isAncestorOf, layout, lightweightPrint, list, list, locate, minimumSize, nextFocus, paintComponents, postProcessKeyEvent, postsOldMouseEvents, preferredSize, preProcessKeyEvent, print, printComponents, printOneComponent, processContainerEvent, processEvent, proxyEnableEvents, proxyRequestFocus, remove, remove, removeAll, removeContainerListener, setFocusOwner, setLayout, transferFocus, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, areInputMethodsEnabled, bounds, checkImage, checkImage, coalesceEvents, constructComponentName, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont_NoClientCode, getFont, getFontMetrics, getForeground, getInputContext, getLocale, getLocation, getLocationOnScreen, getName, getNativeContainer, getParent_NoClientCode, getParent, getPeer, getSize, getToolkit, getToolkitImpl, getTreeLock, getWindowForObject, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isEnabledImpl, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

toolTipKey

protected java.lang.String toolTipKey
Defines the key used to find this internal text area's tool tip.

module

protected java.lang.String module
Defines the module where to find this internal text area's text and tool tip.

manager

private PManager manager
The manager where this component will lokk for its resources.

defaultMouseListener

public final java.awt.event.MouseListener defaultMouseListener
Default mouse listener for editing operations.
Presented here so you can unbregister it.
Constructor Detail

PTextArea

public PTextArea()
Constructs a new text area.

PTextArea

PTextArea(javax.swing.text.Document doc)
Constructs a new text area with the given document model, and defaults for all of the other arguments (null, 0, 0).
Parameters:
doc - The text storage to use. If this is null, a default will be provided by calling the createDefaultModel method.

PTextArea

PTextArea(int rows,
          int columns)
Constructs a new empty TextArea with the specified number of rows and columns.
Parameters:
rows - The number of rows >= 0.
columns - The number of columns >= 0.

PTextArea

PTextArea(java.lang.String text,
          int rows,
          int columns)
Constructs a new TextArea with the specified text and number of rows and columns.
Parameters:
text - The text to be displayed, or null.
rows - The number of rows >= 0.
columns - The number of columns >= 0.

PTextArea

PTextArea(javax.swing.text.Document doc,
          java.lang.String text,
          int rows,
          int columns)
Constructs a new text area with the specified number of rows and columns, and the given model.
Parameters:
doc - The text storage to use. If this is null, a default will be provided by calling the createDefaultModel method.
text - The text to be displayed, or null.
rows - The number of rows >= 0.
columns - The number of columns >= 0.

PTextArea

public PTextArea(java.lang.String toolTipKey)
Creates a new text area with localized capabilities.
Parameters:
toolTipKey - The key used to get the localized tool tip.

PTextArea

public PTextArea(java.lang.String toolTipKey,
                 java.lang.String module)
Creates a new text area with localized capabilities.
Parameters:
toolTipKey - The key used to get the localized tool tip.
module - The module used to load localized resources.

PTextArea

public PTextArea(java.lang.String toolTipKey,
                 java.lang.String module,
                 java.lang.String text)
Creates a new text area with localized capabilities.
Parameters:
toolTipKey - The key used to get the localized tool tip.
module - The module used to load localized resources.
text - The text to be displayed, or null.

PTextArea

public PTextArea(java.lang.String toolTipKey,
                 java.lang.String module,
                 java.lang.String text,
                 int rows,
                 int columns)
Creates a new text area with localized capabilities.
Parameters:
toolTipKey - The key used to get the localized tool tip.
module - The module used to load localized resources.
text - The text to be displayed, or null.
rows - The number of rows >= 0.
columns - The number of columns >= 0.

PTextArea

public PTextArea(java.lang.String toolTipKey,
                 java.lang.String module,
                 javax.swing.text.Document doc,
                 java.lang.String text,
                 int rows,
                 int columns)
Creates a new text area with localized capabilities.
Parameters:
toolTipKey - The key used to get the localized tool tip.
module - The module used to load localized resources.
doc - The text storage to use. If this is null, a default will be provided by calling the createDefaultModel method.
text - The text to be displayed, or null.
rows - The number of rows >= 0.
columns - The number of columns >= 0.
Method Detail

setManager

public void setManager(PManager manager)
Sets the manager of this component.
Specified by:
setManager in interface PComponent
Parameters:
manager - the new manager of this component, if manager is null, the component will use PManager.getInstance().

getManager

public PManager getManager()
Returns the manager of this component.
Specified by:
getManager in interface PComponent
Returns:
The manager of this component.

setModule

public void setModule(java.lang.String module)
Sets The module where the component will search its resources
Specified by:
setModule in interface PComponent
Parameters:
module - The new module. If null, the default resource set will be used.

setLocalizedToolTipText

public void setLocalizedToolTipText(java.lang.String toolTipKey)
Registers the text to display in a tool tip. The text displays when the cursor lingers over the component.
Parameters:
toolTipKey - The key used to get the localized tool tip.

updateFont

public void updateFont()
Update the component's font.
Specified by:
updateFont in interface PComponent

updateLanguage

public void updateLanguage()
Updates the language of the interface.
Specified by:
updateLanguage in interface PComponent

updateLanguage

public void updateLanguage(java.lang.String module)
Updates the language of the interface.
Specified by:
updateLanguage in interface PComponent
Parameters:
module - The module from which are loaded localized resources.

getTextKey

public java.lang.String getTextKey()
Returns the key used to find this component's text
Specified by:
getTextKey in interface PComponent
Returns:
The key used to find this internal text area's text, null if the component does not support text.

getToolTipKey

public java.lang.String getToolTipKey()
Returns the key used to find this internal text area's tool tip.
Specified by:
getToolTipKey in interface PComponent
Returns:
The key used to find this internal text area's tool tip, null if the component does not support tool tip.

getModule

public java.lang.String getModule()
Returns the component's resources location.
Specified by:
getModule in interface PComponent
Returns:
The component's resources location or PComponent.DEFAULT_MODULE if the component has no defined module