Package rma.swing

Class AbstractTextEditorPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

rma.swing.EnabledJPanel

rma.swing.AbstractTextEditorPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Modifiable

public abstract class AbstractTextEditorPanel
extends EnabledJPanel
implements Modifiable

component to support basic editing of ASCII files.

See Also:

• Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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	Description
protected ReflectMultiListener	_listener
protected org.fife.ui.rtextarea.RTextScrollPane	_scrollPane
protected org.fife.ui.rsyntaxtextarea.RSyntaxTextArea	_txtArea

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	Description
AbstractTextEditorPanel()	create a new AbstractTextEditorPanel

Method Summary

Modifier and Type	Method	Description
protected void	buildControls()	create the controls for this panel
protected abstract boolean	canCreateMenus()	override method to say whether this panel should create the default menus
protected boolean	canSaveAs()	override method to say whether the panel can do a save as.
void	closeAction()
void	copyAction()	copy the selected text
protected JMenuBar	createMenus()	create the menus for this component if we're allowed to
void	cutAction()	cut the selected text
void	findAction()
protected UndoableEdit	getLastEdit()
String	getSelectedText()
String	getText()	get the text
protected JTextArea	getTextArea()
Font	getTextFont()	get the Font that the text area is using.
void	gotoLineNumber()
void	gotoLineNumber(int lineNumber)
boolean	isEditable()
boolean	isModified()
void	pasteAction()	paste the text in the clipboard
protected UndoableEdit	popLastEdit()
void	printAction()	display
protected void	registerListeners()	register the listeners used by this class and it components
void	replaceAction()
abstract boolean	saveAction()	save this contents of the textArea
void	selectAllAction()	select the text
protected void	setAllowEditing(boolean canEdit)
void	setEditable(boolean tf)	set the TextArea editable
void	setModified(boolean modified)
void	setText(String txt)	set the text of the TextArea
void	setTextFont(Font f)	set the Font for the text area
void	undoAction()	undo the last Undoable Event.
protected void	updateMenu()	update the undo/redo menus to reflect the last undo event

Methods inherited from class rma.swing.EnabledJPanel

getToolTipText, setComponentEnabled, setEnabled

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, 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, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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 Details

_txtArea

protected org.fife.ui.rsyntaxtextarea.RSyntaxTextArea _txtArea

_scrollPane

protected org.fife.ui.rtextarea.RTextScrollPane _scrollPane

_listener

protected ReflectMultiListener _listener

Constructor Details

AbstractTextEditorPanel

public AbstractTextEditorPanel()

create a new AbstractTextEditorPanel

Method Details

buildControls

protected void buildControls()

create the controls for this panel

createMenus

protected JMenuBar createMenus()

create the menus for this component if we're allowed to

See Also:

• canCreateMenus()

registerListeners

protected void registerListeners()

register the listeners used by this class and it components

canCreateMenus

protected abstract boolean canCreateMenus()

override method to say whether this panel should create the default menus

Returns:

true if this class should create the default menus

saveAction

public abstract boolean saveAction()

save this contents of the textArea

Returns:

true if the save was successful

canSaveAs

protected boolean canSaveAs()

override method to say whether the panel can do a save as. If overridden to return true, then also override saveAsAction()

Returns:

false by default.

setEditable

public void setEditable(boolean tf)

set the TextArea editable

isEditable

public boolean isEditable()

setText

public void setText(String txt)

set the text of the TextArea

Parameters:

txt - the new text

getText

public String getText()

get the text

Returns:

the text

setAllowEditing

protected void setAllowEditing(boolean canEdit)

Parameters:

canEdit -

cutAction

public void cutAction()

cut the selected text

See Also:

• JTextComponent.cut()

copyAction

public void copyAction()

copy the selected text

See Also:

• JTextComponent.copy()

pasteAction

public void pasteAction()

paste the text in the clipboard

See Also:

• JTextComponent.paste()

selectAllAction

public void selectAllAction()

select the text

See Also:

• JTextComponent.selectAll()

getSelectedText

public String getSelectedText()

Returns:

closeAction

public void closeAction()

updateMenu

protected void updateMenu()

update the undo/redo menus to reflect the last undo event

popLastEdit

protected UndoableEdit popLastEdit()

getLastEdit

protected UndoableEdit getLastEdit()

printAction

public void printAction()

display

gotoLineNumber

public void gotoLineNumber()

gotoLineNumber

public void gotoLineNumber(int lineNumber)

undoAction

public void undoAction()

undo the last Undoable Event.

findAction

public void findAction()

replaceAction

public void replaceAction()

isModified

public boolean isModified()

Specified by:

isModified in interface Modifiable

setModified

public void setModified(boolean modified)

Specified by:

setModified in interface Modifiable

getTextArea

protected JTextArea getTextArea()

setTextFont

public void setTextFont(Font f)

set the Font for the text area

Parameters:

f - the new Font

getTextFont

public Font getTextFont()

get the Font that the text area is using.

Returns: