org.compiere.swing
Class CTextPane

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants, CEditor

Direct Known Subclasses:

VTextLong

public class CTextPane
extends JScrollPane
implements CEditor

Compiere TextPane - A ScrollPane with a JTextPane. Manages visibility, opaque and color consistently *

Version:

$Id: CTextPane.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

CTextPane()
Constructs a new TextPane (HTML)

CTextPane(JTextPane textPane)
Create a JScrollArea with a JTextEditor

CTextPane(StyledDocument doc)
Constructs a new JTextPane with the given document

Method Summary

void	addFocusListener(FocusListener l) Add Focus Listener
void	addInputMethodListener(InputMethodListener l) Add Input Method Listener
void	addKeyListener(KeyListener l) Add Key Listener
void	addMouseListener(MouseListener l) Add Mouse Listener
Action[]	getActions() Get Editor Actions
Color	getBackground() Get Background
int	getCaretPosition() Get Caret Position
String	getDisplay() Return Display Value
Component	getFocusableComponent() Get Focus Component
Color	getForeground() Get Foreground
InputMethodRequests	getInputMethodRequests() Get Input Method Requests
String	getText() Get Text
Object	getValue() Return Editor value
boolean	isEditable() Editable
boolean	isMandatory() Is Field mandatory
boolean	isReadWrite() Is it possible to edit
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
void	setCaretPosition(int pos) Set Caret Position
void	setContentType(String type) Set Content Type
void	setEditable(boolean edit) Set Editable
void	setForeground(Color color) Set Foreground
void	setInputVerifier(InputVerifier l) Set Input Verifier
void	setMandatory(boolean mandatory) Set Editor Mandatory
void	setMargin(Insets m) Set Text Margin
void	setOpaque(boolean isOpaque) Set Opaque
void	setPage(URL url) Set Editor to page
void	setReadWrite(boolean rw) Enable Editor
void	setText(String text) Set Text and position top
void	setValue(Object value) Set Editor to value
void	write(Writer out) Write content

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

CTextPane

public CTextPane()

Constructs a new TextPane (HTML)

CTextPane

public CTextPane(StyledDocument doc)

Constructs a new JTextPane with the given document

Parameters:

doc - the model to use

CTextPane

public CTextPane(JTextPane textPane)

Create a JScrollArea with a JTextEditor

Parameters:

textPane -

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

Overrides:

setBackground in class JComponent

Parameters:

color - color

getBackground

public Color getBackground()

Get Background

Overrides:

getBackground in class Component

Returns:

color

setForeground

public void setForeground(Color color)

Set Foreground

Overrides:

setForeground in class JComponent

Parameters:

color - color

getForeground

public Color getForeground()

Get Foreground

Overrides:

getForeground in class Component

Returns:

color

setContentType

public void setContentType(String type)

Set Content Type

Parameters:

type - e.g. text/html

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

setCaretPosition

public void setCaretPosition(int pos)

Set Caret Position

Parameters:

pos - pos

getCaretPosition

public int getCaretPosition()

Get Caret Position

Returns:

position

setEditable

public void setEditable(boolean edit)

Set Editable

Parameters:

edit - editable

isEditable

public boolean isEditable()

Editable

Returns:

true if editable

setMargin

public void setMargin(Insets m)

Set Text Margin

Parameters:

m - insets

setOpaque

public void setOpaque(boolean isOpaque)

Set Opaque

Overrides:

setOpaque in class JComponent

Parameters:

isOpaque - opaque

addFocusListener

public void addFocusListener(FocusListener l)

Add Focus Listener

Overrides:

addFocusListener in class Component

Parameters:

l - listener

addMouseListener

public void addMouseListener(MouseListener l)

Add Mouse Listener

Overrides:

addMouseListener in class Component

Parameters:

l - listner

addKeyListener

public void addKeyListener(KeyListener l)

Add Key Listener

Overrides:

addKeyListener in class Component

Parameters:

l - listner

addInputMethodListener

public void addInputMethodListener(InputMethodListener l)

Add Input Method Listener

Overrides:

addInputMethodListener in class Component

Parameters:

l - listener

getInputMethodRequests

public InputMethodRequests getInputMethodRequests()

Get Input Method Requests

Overrides:

getInputMethodRequests in class Component

Returns:

requests

setInputVerifier

public void setInputVerifier(InputVerifier l)

Set Input Verifier

Overrides:

setInputVerifier in class JComponent

Parameters:

l - verifyer

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

getActions

public Action[] getActions()

Get Editor Actions

Returns:

actions

write

public void write(Writer out)
           throws IOException

Write content

Parameters:

out - writer

Throws:

IOException

setPage

public void setPage(URL url)
             throws IOException

Set Editor to page

Parameters:

url - url

Throws:

IOException