org.mdiutil.swing

Class AbstractMultilineDialog

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.mdiutil.swing.AbstractMultilineDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

JMultilineDialog

public abstract class AbstractMultilineDialog
extends JComponent

An abstract MultilineDialog.

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 boolean	allowImport True if the dialog allow to import a text file.
static int	APPROVE_OPTION
static int	CANCEL_OPTION
protected AbstractAction	cancelaction The Cancel action.
protected Dimension	dim The dialog dimension.
protected File	dir The default directory if the dialog allow to import a text file.
protected AbstractAction	importAction The import action.
protected JTextComponent	textComp The text component.
protected ExtensionFileFilter	txtfilter The file filter if the dialog allow to import a text file.
protected AbstractAction	yesaction The Yes action.

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
AbstractMultilineDialog(JTextComponent textComp) Constructor.

Method Summary

Modifier and Type	Method and Description
JDialog	createDialog(String title, Component parent) Create the dialog.
protected JPanel	createYesNoPanel() Create the Yes / No bottom Panel.
protected void	doCancel() Called when the user clicks on the Cancel button.
protected void	doYes() Called when the user clicks on the Yes button.
Dimension	getDialogDimension() Return the dimension of the dialog.
String	getDialogTitle() Return the dialog title.
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.
boolean	isAllowingImport() Return true if the editor has an import text file option.
boolean	isEditable() Return true if the text is editable.
void	setAllowImport(boolean allowImport) Set if the editor has an import text file option.
void	setDialogDimension(Dimension dim) Set the dimension of the dialog.
void	setDialogTitle(String dialogTitle) Set the dialog title.
void	setEditable(boolean isEditable) Set if the text is editable.
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.
void	setText(String text) Set the associated text.
protected abstract void	setUp() Set up the panel contents.
int	showDialog(Component parent) Show the dialog.

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, 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, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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, 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, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

textComp

protected JTextComponent textComp

The text component.

dim

protected Dimension dim

The dialog dimension.

yesaction

protected AbstractAction yesaction

The Yes action.

cancelaction

protected AbstractAction cancelaction

The Cancel action.

importAction

protected AbstractAction importAction

The import action.

allowImport

protected boolean allowImport

True if the dialog allow to import a text file.

dir

protected File dir

The default directory if the dialog allow to import a text file.

txtfilter

protected ExtensionFileFilter txtfilter

The file filter if the dialog allow to import a text file.

APPROVE_OPTION

public static final int APPROVE_OPTION

See Also:

Constant Field Values

CANCEL_OPTION

public static final int CANCEL_OPTION

See Also:

Constant Field Values

Constructor Detail

AbstractMultilineDialog

public AbstractMultilineDialog(JTextComponent textComp)

Constructor.

Parameters:

textComp - the text component

Method Detail

setEditable

public void setEditable(boolean isEditable)

Set if the text is editable.

Parameters:

isEditable - true if the text is editable

isEditable

public boolean isEditable()

Return true if the text is editable.

Returns:

true if the text is editable

setDialogTitle

public void setDialogTitle(String dialogTitle)

Set the dialog title.

Parameters:

dialogTitle - the dialog title

getDialogTitle

public String getDialogTitle()

Return the dialog title.

Returns:

the dialog title

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

setDialogDimension

public void setDialogDimension(Dimension dim)

Set the dimension of the dialog.

Parameters:

dim - the dimension

getDialogDimension

public Dimension getDialogDimension()

Return the dimension of the dialog.

Returns:

the dimension

showDialog

public int showDialog(Component parent)
               throws HeadlessException

Show the dialog.

Parameters:

parent - the parent component

Returns:

the return value

Throws:

HeadlessException

createDialog

public JDialog createDialog(String title,
                            Component parent)
                     throws HeadlessException

Create the dialog.

Parameters:

title - the dialog title

parent - the parent component

Returns:

the dialog

Throws:

HeadlessException

setUp

protected abstract void setUp()

Set up the panel contents.

setText

public void setText(String text)

Set the associated text.

Parameters:

text - the text

createYesNoPanel

protected JPanel createYesNoPanel()

Create the Yes / No bottom Panel. Note that it is possible to define a completely different panel can be defined by overriding this method. It is even possible to define a panel with a completely different content, even without Yes /No buttons.

Returns:

the Yes/No Panel

doYes

protected void doYes()

Called when the user clicks on the Yes button.

doCancel

protected void doCancel()

Called when the user clicks on the Cancel button.