de.esprit.common.gui.editor

Class TextEditorFrame<C extends ApplicationContext>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

de.esprit.common.gui.ZFrame

de.esprit.appsuite.gui.ToolFrame<C>

de.esprit.common.gui.editor.TextEditorFrame<C>

All Implemented Interfaces:

ApplicationToolWindow<C>, ApplicationObject<C>, Applieable, BorderLayoutConstants, Cancellable, Closeable, ToolWindow, SimpleLogSupport, Clearable, Dumpable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:

TextViewerFrame

public class TextEditorFrame<C extends ApplicationContext>
extends ToolFrame<C>
implements Applieable

This is a ToolFrame containing a full functional ASCII text editor

Author:

Rainer Buesch

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface de.esprit.common.gui.comp.BorderLayoutConstants

CENTER, EAST, NORTH, SOUTH, WEST

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
TextEditorFrame(C ctx)
TextEditorFrame(C ctx, int rows, int cols)
TextEditorFrame(C ctx, NlsKey titleKey, int rows, int cols)

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.swing.JMenuBar	createMenuBar()
protected void	doOnApply() Should be overridden in order to provide an apply action
boolean	doOnClose() This method is called before this frame is made invisible.
java.io.File	getCurrentFile()
java.lang.String	getFrameTitle()
java.lang.String	getSelectedText()
java.lang.String	getText()
TextBuffer	getTextBuffer()
TextEditorPanel	getTextPanel()
java.awt.Image	getTitleImage()
java.lang.String	getTitleString()
protected boolean	hasApplyButton() Defines whether an Apply button should be displayed (default false).
protected boolean	hasClearTextButton()
protected boolean	hasCloseButton() Defines whether a Close button should be displayed (default false).
protected boolean	hasFindButton()
protected boolean	isClosedOnApply() Defines whether the frame should be closed on apply - default is true
boolean	isEditable()
int	loadFromFile(java.io.File file)
static void	main(java.lang.String[] args)
void	setCurrentFile(java.io.File file)
void	setEditable(boolean isEditable)
void	setText(java.lang.String text)
void	updateFrameTitle()

Methods inherited from class de.esprit.appsuite.gui.ToolFrame

addApplyListener, apply, cancel, clear, close, closeByIcon, createButtonPanel, createWindowAdapter, doOnApplyError, doOnCancel, doOnPopup, getApplicationContext, getApplier, getApplyAndCloseButton, getApplyButton, getButtonPanel, getCaller, getCancelButton, getClearButton, getCloseButton, getLogChannel, getPreferredWindowAlignment, getWindowAdapter, hasApplyAndCloseButton, hasButtonPanel, hasCancelButton, hasClearButton, isLogDebug, isLogVerbose, locate, logDebug, logDump, logError, logError, logFatal, logInfo, logVerbose, logWarning, pack, popup, removeApplyListener, setDefaultButton, setLogChannel, setRelocateOnPopup, wasCancelled

Methods inherited from class de.esprit.common.gui.ZFrame

getMinimumHeight, getMinimumWidth, isErrorAttachable, isLocated, isPacked, repack, setIcon, setIcon, setLocation, setLocationRelativeTo, setLocationRelativeTo, setLocationToCenter, setTitle, setVisible, shiftLocation, toDumpString, toDumpString, toString, toString

Methods inherited from class javax.swing.JFrame

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

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocationByPlatform, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, toBack, 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, getPeer, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.esprit.common.gui.comp.Applieable

apply

Methods inherited from interface de.esprit.appsuite.gui.ApplicationToolWindow

getRootPane

Methods inherited from interface de.esprit.common.gui.ToolWindow

getLocation, getMinimumHeight, getMinimumWidth, getSize, getTitle, getToolkit, isPacked, setLocation, setLocationRelativeTo, setMinimumSize, setPreferredSize, shiftLocation

Methods inherited from interface de.esprit.common.type.Dumpable

toDumpString, toDumpString, toString, toString

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

TextEditorFrame

public TextEditorFrame(C ctx)

TextEditorFrame

public TextEditorFrame(C ctx,
               int rows,
               int cols)

TextEditorFrame

public TextEditorFrame(C ctx,
               NlsKey titleKey,
               int rows,
               int cols)

Method Detail

createMenuBar

protected javax.swing.JMenuBar createMenuBar()

setEditable

public void setEditable(boolean isEditable)

isEditable

public boolean isEditable()

hasFindButton

protected boolean hasFindButton()

hasClearTextButton

protected boolean hasClearTextButton()

hasCloseButton

protected boolean hasCloseButton()

Description copied from class: ToolFrame

Defines whether a Close button should be displayed (default false). Note that the Close button just calls the close() method.

Overrides:

hasCloseButton in class ToolFrame<C extends ApplicationContext>

hasApplyButton

protected boolean hasApplyButton()

Description copied from class: ToolFrame

Defines whether an Apply button should be displayed (default false). Note that the Apply button just calls the apply() method.

Overrides:

hasApplyButton in class ToolFrame<C extends ApplicationContext>

doOnClose

public boolean doOnClose()

Description copied from class: ToolFrame

This method is called before this frame is made invisible. Closing can be vetoed by returning false.

Overrides:

doOnClose in class ToolFrame<C extends ApplicationContext>

Returns:

true by default.

doOnApply

protected void doOnApply()
                  throws java.lang.Exception

Description copied from class: ToolFrame

Should be overridden in order to provide an apply action

Overrides:

doOnApply in class ToolFrame<C extends ApplicationContext>

Throws:

java.lang.Exception

isClosedOnApply

protected boolean isClosedOnApply()

Description copied from class: ToolFrame

Defines whether the frame should be closed on apply - default is true

Overrides:

isClosedOnApply in class ToolFrame<C extends ApplicationContext>

getTitleString

public java.lang.String getTitleString()

getTitleImage

public java.awt.Image getTitleImage()

getFrameTitle

public java.lang.String getFrameTitle()

updateFrameTitle

public void updateFrameTitle()

setText

public void setText(java.lang.String text)

getText

public java.lang.String getText()

getSelectedText

public java.lang.String getSelectedText()

setCurrentFile

public void setCurrentFile(java.io.File file)

getCurrentFile

public java.io.File getCurrentFile()

loadFromFile

public int loadFromFile(java.io.File file)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getTextPanel

public TextEditorPanel getTextPanel()

getTextBuffer

public TextBuffer getTextBuffer()

main

public static void main(java.lang.String[] args)