Package adams.gui.dialog

Class TextDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

adams.gui.core.BaseDialog

adams.gui.dialog.TextDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class TextDialog
extends BaseDialog

A simple dialog for displaying text.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

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	Description
protected TextPanel	m_TextPanel	for displaying the text.

Fields inherited from class adams.gui.core.BaseDialog

m_AfterHideActions, m_AfterShowActions, m_BeforeHideActions, m_BeforeShowActions, m_DisposeCalled, m_UISettingsApplied, m_UISettingsPrefix, m_UISettingsStored

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
TextDialog()	Creates a modeless dialog without a title and without a specified Frame owner.
TextDialog(Dialog owner)	Creates a modeless dialog without a title with the specified Dialog as its owner.
TextDialog(Dialog owner, Dialog.ModalityType modality)	Creates a dialog with the specified owner Dialog and modality.
TextDialog(Dialog owner, String title)	Creates a modeless dialog with the specified title and with the specified owner dialog.
TextDialog(Dialog owner, String title, Dialog.ModalityType modality)	Creates a dialog with the specified title, modality and the specified owner Dialog.
TextDialog(Frame owner)	Creates a modeless dialog without a title with the specified Frame as its owner.
TextDialog(Frame owner, boolean modal)	Creates a dialog with the specified owner Frame, modality and an empty title.
TextDialog(Frame owner, String title)	Creates a modeless dialog with the specified title and with the specified owner frame.
TextDialog(Frame owner, String title, boolean modal)	Creates a dialog with the specified owner Frame, modality and title.

Method Summary

Modifier and Type	Method	Description
boolean	getCanOpenFiles()	Returns whether the editor can open files.
String	getContent()	Returns the content to display.
String	getDialogTitle()	Returns the (base) title in use.
boolean	getLineWrap()	Returns whether line wrap is enabled.
int	getTabSize()	Returns the tab size, i.e., the number of maximum width characters.
Font	getTextFont()	Returns the font currently in use by the text area.
boolean	getUpdateParentTitle()	Returns whether to update the parent's title.
protected void	initGUI()	For initializing the GUI.
boolean	isEditable()	Returns whether the text area is editable or not.
boolean	isModified()	Returns whether the content has been modified.
void	open(File file)	Opens the specified file using UTF-8 and loads/displays the content.
void	open(File file, String encoding)	Opens the specified file and loads/displays the content.
void	setCanOpenFiles(boolean value)	Sets whether the editor can open files.
void	setContent(String value)	Sets the content to display.
void	setDialogTitle(String value)	Sets the (base) title to use.
void	setEditable(boolean value)	Sets whether the text area is editable or not.
void	setLineWrap(boolean value)	Enables/disables line wrap.
void	setModified(boolean value)	Sets the modified state.
void	setTabSize(int value)	Sets the tab size, i.e., the number of maximum width characters.
void	setTextFont(Font value)	Sets the font of the text area.
void	setUpdateParentTitle(boolean value)	Sets whether to update the parent's title.

Methods inherited from class adams.gui.core.BaseDialog

addAfterHideAction, addAfterShowAction, addBeforeHideAction, addBeforeShowAction, afterHide, afterShow, applyUISettings, beforeHide, beforeShow, dispose, executeAfterHideActions, executeAfterShowActions, executeBeforeHideActions, executeBeforeShowActions, finishInit, getUISettingsApplied, getUISettingsPrefix, initialize, pack, removeAfterHideAction, removeAfterShowAction, removeBeforeHideAction, removeBeforeShowAction, setLocationRelativeTo, setUISettingsPrefix, setUISettingsPrefix, setVisible, storeUISettings

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, 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

m_TextPanel

protected TextPanel m_TextPanel

for displaying the text.

Constructor Detail

TextDialog

public TextDialog()

Creates a modeless dialog without a title and without a specified Frame owner.

TextDialog

public TextDialog(Dialog owner)

Creates a modeless dialog without a title with the specified Dialog as its owner.

Parameters:

owner - the owning dialog

TextDialog

public TextDialog(Dialog owner,
                  Dialog.ModalityType modality)

Creates a dialog with the specified owner Dialog and modality.

Parameters:

owner - the owning dialog

modality - the type of modality

TextDialog

public TextDialog(Dialog owner,
                  String title)

Creates a modeless dialog with the specified title and with the specified owner dialog.

Parameters:

owner - the owning dialog

title - the title of the dialog

TextDialog

public TextDialog(Dialog owner,
                  String title,
                  Dialog.ModalityType modality)

Creates a dialog with the specified title, modality and the specified owner Dialog.

Parameters:

owner - the owning dialog

title - the title of the dialog

modality - the type of modality

TextDialog

public TextDialog(Frame owner)

Creates a modeless dialog without a title with the specified Frame as its owner.

Parameters:

owner - the owning frame

TextDialog

public TextDialog(Frame owner,
                  boolean modal)

Creates a dialog with the specified owner Frame, modality and an empty title.

Parameters:

owner - the owning frame

modal - whether the dialog is modal or not

TextDialog

public TextDialog(Frame owner,
                  String title)

Creates a modeless dialog with the specified title and with the specified owner frame.

Parameters:

owner - the owning frame

title - the title of the dialog

TextDialog

public TextDialog(Frame owner,
                  String title,
                  boolean modal)

Creates a dialog with the specified owner Frame, modality and title.

Parameters:

owner - the owning frame

title - the title of the dialog

modal - whether the dialog is modal or not

Method Detail

initGUI

protected void initGUI()

For initializing the GUI.

Overrides:

initGUI in class BaseDialog

setDialogTitle

public void setDialogTitle(String value)

Sets the (base) title to use.

Parameters:

value - the base title

See Also:

TextPanel.setTitle(String)

getDialogTitle

public String getDialogTitle()

Returns the (base) title in use.

Returns:

the base title

See Also:

TextPanel.getTitle()

setModified

public void setModified(boolean value)

Sets the modified state.

Parameters:

value - if true then the content is flagged as modified

isModified

public boolean isModified()

Returns whether the content has been modified.

Returns:

true if the content was modified

setContent

public void setContent(String value)

Sets the content to display. Resets the modified state.

Parameters:

value - the text

getContent

public String getContent()

Returns the content to display.

Returns:

the text

setEditable

public void setEditable(boolean value)

Sets whether the text area is editable or not.

Parameters:

value - if true then the text will be editable

isEditable

public boolean isEditable()

Returns whether the text area is editable or not.

Returns:

true if the text is editable

setTextFont

public void setTextFont(Font value)

Sets the font of the text area.

Parameters:

value - the font to use

getTextFont

public Font getTextFont()

Returns the font currently in use by the text area.

Returns:

the font in use

setTabSize

public void setTabSize(int value)

Sets the tab size, i.e., the number of maximum width characters.

Parameters:

value - the number of maximum width chars

getTabSize

public int getTabSize()

Returns the tab size, i.e., the number of maximum width characters.

Returns:

the number of maximum width chars

setLineWrap

public void setLineWrap(boolean value)

Enables/disables line wrap.

Parameters:

value - if true line wrap gets enabled

getLineWrap

public boolean getLineWrap()

Returns whether line wrap is enabled.

Returns:

true if line wrap enabled

setUpdateParentTitle

public void setUpdateParentTitle(boolean value)

Sets whether to update the parent's title.

Parameters:

value - if true the parent's title will get updated

getUpdateParentTitle

public boolean getUpdateParentTitle()

Returns whether to update the parent's title.

Returns:

true if to update the parent's title

setCanOpenFiles

public void setCanOpenFiles(boolean value)

Sets whether the editor can open files.

Parameters:

value - if true then the editor can open files as well

getCanOpenFiles

public boolean getCanOpenFiles()

Returns whether the editor can open files.

Returns:

true if the editor can open files

open

public void open(File file)

Opens the specified file using UTF-8 and loads/displays the content.

Parameters:

file - the file to load

See Also:

getCanOpenFiles()

open

public void open(File file,
                 String encoding)

Opens the specified file and loads/displays the content.

Parameters:

file - the file to load

encoding - the encoding to use, null for default UTF-8

See Also:

getCanOpenFiles()