org.mdiutil.swing

Class JMultilineTextEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.mdiutil.swing.JMultilineTextEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class JMultilineTextEditor
extends JComponent

A Text editor containing a JTextField and a JTextComponent which can be edited through a dialog.

See Also:

Serialized Form

Nested Class Summary

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

Modifier and Type	Field and Description
protected Dimension	dim The Dialog dimension.
protected Document	doc
protected JTextComponent	textComp The text component used in the dialog.

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 and Description
JMultilineTextEditor() Constructor.
JMultilineTextEditor(int columns) Constructor.
JMultilineTextEditor(JTextComponent comp) Constructor.
JMultilineTextEditor(JTextComponent comp, int columns) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener listener) Add an ActionListener.
void	allowDirectEdit(boolean allowDirectEdit) Set if the text in the component can be edited directly (default is true).
protected AbstractMultilineDialog	createMultilineDialog() Create the dialog which will be used to edit the text.
void	doLayout()
Dimension	getDialogDimension() Return the dimension of the dialog.
Document	getDocument() Return the associated Document.
File	getImportDefaultDirectory() Return the default directory if the editor has an import text file option.
ExtensionFileFilter	getImportFileFilter() Return the file filter if the editor has an import text file option.
Dimension	getPreferredSize()
String	getText() Return the assocuated text.
JTextComponent	getTextComponent()
boolean	isAllowingDirectEdit() Return true if the text in the component can be edited directly (default is true).
boolean	isAllowingImport() Return true if the editor has an import text file option.
boolean	isEditable() Return true if the text is editable.
boolean	isEnabled() Return true if the List Selector is enabled.
void	removeActionListener(ActionListener listener) Removes an ActionListener.
void	reset() Resets the selector to the values of thetext component.
void	setAllowImport(boolean allowImport) Set if the editor has an import text file option.
void	setBackground(Color color)
void	setDialogDimension(Dimension dim) Set the dimension of the dialog.
void	setDocument(Document doc) Set the associated Document.
void	setEditable(boolean isEditable) Set if the text is editable.
void	setEnabled(boolean enabled) Enables or disables this component.
void	setImportDefaultDirectory(File dir) Set the default directory if the editor has an import text file option.
void	setImportFileFilter(ExtensionFileFilter filter) Set the file filter if the editor has an import text file option.
protected void	setText() Set the text in the component.
void	setText(String text) Set the associated text.
void	setTextComponent(JTextComponent comp) Set the text component to use with the text editor.
String	toString()
void	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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, 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, 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, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

doc

protected Document doc

textComp

protected JTextComponent textComp

The text component used in the dialog.

dim

protected Dimension dim

The Dialog dimension. The default value is null.

Constructor Detail

JMultilineTextEditor

public JMultilineTextEditor()

Constructor.

JMultilineTextEditor

public JMultilineTextEditor(JTextComponent comp)

Constructor.

Parameters:

comp - the text component

JMultilineTextEditor

public JMultilineTextEditor(int columns)

Constructor.

Parameters:

columns - the number of columns of the text component

JMultilineTextEditor

public JMultilineTextEditor(JTextComponent comp,
                            int columns)

Constructor.

Parameters:

comp - the text component

columns - the number of columns of the text component

Method Detail

updateUI

public void updateUI()

Overrides:

updateUI in class JComponent

setDialogDimension

public void setDialogDimension(Dimension dim)

Set the dimension of the dialog.

Parameters:

dim - the dimension

setAllowImport

public void setAllowImport(boolean allowImport)

Set if the editor has an import text file option.

Parameters:

allowImport - true if the editor has an import text file option

isAllowingImport

public boolean isAllowingImport()

Return true if the editor has an import text file option.

Returns:

true if the editor has an import text file option

setImportDefaultDirectory

public void setImportDefaultDirectory(File dir)

Set the default directory if the editor has an import text file option.

Parameters:

dir - the default directory if the editor has an import text file option

getImportDefaultDirectory

public File getImportDefaultDirectory()

Return the default directory if the editor has an import text file option.

Returns:

the default directory if the editor has an import text file option

setImportFileFilter

public void setImportFileFilter(ExtensionFileFilter filter)

Set the file filter if the editor has an import text file option.

Parameters:

filter - the file filter if the editor has an import text file option

getImportFileFilter

public ExtensionFileFilter getImportFileFilter()

Return the file filter if the editor has an import text file option.

Returns:

the file filter if the editor has an import text file option

getDialogDimension

public Dimension getDialogDimension()

Return the dimension of the dialog.

Returns:

the dimension

setEditable

public void setEditable(boolean isEditable)

Set if the text is editable.

Parameters:

isEditable - true if the text is editable

allowDirectEdit

public void allowDirectEdit(boolean allowDirectEdit)

Set if the text in the component can be edited directly (default is true). If false, editing the text can only be performed by opening the edition dialog.

Parameters:

allowDirectEdit - true if the text in the component can be edited directly

isAllowingDirectEdit

public boolean isAllowingDirectEdit()

Return true if the text in the component can be edited directly (default is true). If false, editing the text can only be performed by opening the edition dialog.

Returns:

if the text in the component can be edited directly

isEditable

public boolean isEditable()

Return true if the text is editable.

Returns:

true if the text is editable

getTextComponent

public JTextComponent getTextComponent()

setTextComponent

public void setTextComponent(JTextComponent comp)

Set the text component to use with the text editor.

Parameters:

comp - the text component

getDocument

public Document getDocument()

Return the associated Document.

Returns:

the associated Document

getText

public String getText()

Return the assocuated text.

Returns:

the assocuated text

setDocument

public void setDocument(Document doc)

Set the associated Document.

Parameters:

doc - the Document

setText

public void setText(String text)

Set the associated text.

Parameters:

text - the text

addActionListener

public void addActionListener(ActionListener listener)

Add an ActionListener.

Parameters:

listener - the ActionListener

removeActionListener

public void removeActionListener(ActionListener listener)

Removes an ActionListener.

Parameters:

listener - the ActionListener

toString

public String toString()

Overrides:

toString in class Component

reset

public void reset()

Resets the selector to the values of thetext component.

doLayout

public void doLayout()

Overrides:

doLayout in class Container

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

setBackground

public void setBackground(Color color)

Overrides:

setBackground in class JComponent

setEnabled

public void setEnabled(boolean enabled)

Enables or disables this component.

Overrides:

setEnabled in class JComponent

Parameters:

enabled - true if this component should be enabled, false otherwise

isEnabled

public boolean isEnabled()

Return true if the List Selector is enabled.

Overrides:

isEnabled in class Component

Returns:

true if the List Selector is enabled

setText

protected void setText()

Set the text in the component.

createMultilineDialog

protected AbstractMultilineDialog createMultilineDialog()

Create the dialog which will be used to edit the text.

Returns:

the dialog