lapisx.swing
Class FileEditorPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  lapisx.swing.FileEditorPanel

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

TCFileEditor, TclFileEditor

public class FileEditorPanel

extends JPanel

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

FileEditorPanel()

FileEditorPanel(JTextComponent myEditor)

Method Summary

void	addColorChooser() Add a Select Color button that allows the background color for the text editor to be changed.
void	addFileMenu() Add a file "menu" (actually a combo box) to the toolbar.
void	clear() Clear the editor.
boolean	getDirty() Return the value of the dirty flag, which signals whether or not the editor's contents have been changed but not saved.
JTextComponent	getEditor() Return the editor.
Document	getEditorDocument() Return the document for the editor.
int	getEditorSelectionEnd() Return the ending index of the selection in the editor.
int	getEditorSelectionStart() Return the starting index of the selection in the editor.
File	getFile() Return the file from which the editor contents were loaded, or null if there was none.
String	getText() Return editor contents.
JToolBar	getToolBar() Return the toolbar.
protected void	handleInteractiveException(Exception exception)
protected FileChooser	makeFileChooser() Make a file-chooser object.
boolean	okToClear() Check whether or not the editor has unsaved content; if there is, pops up a dialog box to ask if editor contents should be saved.
void	open() Pop up a file-open dialog to open a file into the editor.
void	open(File f) Open a file (or URL) in the editor.
boolean	save() Pop up a save-as dialog box, then saves the editor contents.
boolean	save(File f) Save editor contents to a local file.
void	setDirty(boolean dirty) Set the dirty flag to the new boolean value.
void	setFile(File file) Set the file from which the editor contents are loaded.
void	setText(String text) Set the editor contents.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

FileEditorPanel

public FileEditorPanel()

FileEditorPanel

public FileEditorPanel(JTextComponent myEditor)

Method Detail

handleInteractiveException

protected void handleInteractiveException(Exception exception)

clear

public void clear()

Clear the editor.

okToClear

public boolean okToClear()

Check whether or not the editor has unsaved content; if there is, pops up a dialog box to ask if editor contents should be saved.

open

public void open()

Pop up a file-open dialog to open a file into the editor.

makeFileChooser

protected FileChooser makeFileChooser()

Make a file-chooser object.

open

public void open(File f)

Open a file (or URL) in the editor. Pops up a dialog box if an error occurs.

Parameters:

f - File to open

save

public boolean save()

Pop up a save-as dialog box, then saves the editor contents.

save

public boolean save(File f)

Save editor contents to a local file.

Parameters:

f - Local file to save

getText

public String getText()

Return editor contents.

Returns:

editor contents as string

setText

public void setText(String text)

Set the editor contents.

getEditor

public JTextComponent getEditor()

Return the editor.

Returns:

editor as a JTextComponent

getEditorSelectionStart

public int getEditorSelectionStart()

Return the starting index of the selection in the editor.

getEditorSelectionEnd

public int getEditorSelectionEnd()

Return the ending index of the selection in the editor.

getEditorDocument

public Document getEditorDocument()

Return the document for the editor.

getToolBar

public JToolBar getToolBar()

Return the toolbar.

Returns:

toolbar as a JToolBar

getDirty

public boolean getDirty()

Return the value of the dirty flag, which signals whether or not the editor's contents have been changed but not saved.

Returns:

the value of the dirty flag as a boolean

setDirty

public void setDirty(boolean dirty)

Set the dirty flag to the new boolean value.

getFile

public File getFile()

Return the file from which the editor contents were loaded, or null if there was none.

Returns:

the name of the file from which the editor was loaded (or null if none exists) as a string

setFile

public void setFile(File file)

Set the file from which the editor contents are loaded.

addFileMenu

public void addFileMenu()

Add a file "menu" (actually a combo box) to the toolbar.

addColorChooser

public void addColorChooser()

Add a Select Color button that allows the background color for the text editor to be changed.

Returns:

nothing

Effects:

adds a button that pops up a color chooser dialog box and sets the background color for the text editor