chargerlib

Class GenericTextFrame

Object

Component

Container

Window

Frame

JFrame

chargerlib.GenericTextFrame

All Implemented Interfaces:

ManagedWindow, ClipboardOwner, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

GenericHTMLFrame

public class GenericTextFrame
extends JFrame
implements ClipboardOwner, ManagedWindow

A general utility class to handle simple text editing and saving. It's the caller's responsibility to load with whatever text is desired. A suggested file can be associated with the window, so that the text can be saved. If used as a regular file editor, loadFile should be called. The title of a text frame is the reqular supported window title. The label is inside the frame window, as a "header" to the content.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	editable
private JMenu	editMenu
private JMenu	fileMenu
(package private) File	fullPathFile
private JMenuBar	jMenuBar1
JLabel	mainLabel
private JMenuItem	menuEditClear
private JMenuItem	menuEditCopy
private JMenuItem	menuEditCut
private JMenuItem	menuEditPaste
private JMenuItem	menuEditSelectAll
private JMenuItem	menuFileClose
private JMenuItem	menuFileSave
JPanel	optionPanel
(package private) JFrame	ownerFrame
protected JScrollPane	scroller
JEditorPane	theText
private JMenu	windowMenu

Fields inherited from class JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class 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 Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
GenericTextFrame(JFrame owner) Creates new form GenericTextFrame
GenericTextFrame(JFrame owner, String title, String label, String text, File suggestedFile) Creates a new TextDisplayFrame with no text in it; use setText to fill it.

Method Summary

Modifier and Type	Method and Description
private void	formComponentResized(ComponentEvent evt)
private void	formWindowClosing(WindowEvent evt)
String	getFilename() If there's a file associated with the window, return its name; null otherwise.
String	getMenuItemLabel() Tells a window manager what label to put on the menu to select this window
String	getTheText()
JMenu	getWindowMenu() The window menu to be populated by the window manager.
private void	initComponents() This method is called from within the constructor to initialize the form.
void	loadFile() Read the frame's suggested file into the frame's text area for editing.
void	lostOwnership(Clipboard clipboard, Transferable contents)
private void	menuEditClearActionPerformed(ActionEvent evt)
private void	menuEditCopyActionPerformed(ActionEvent evt)
private void	menuEditCutActionPerformed(ActionEvent evt)
private void	menuEditSelectAllActionPerformed(ActionEvent evt)
private void	menuFileCloseActionPerformed(ActionEvent evt)
private void	menuFileSaveActionPerformed(ActionEvent evt)
void	setContentType(String type)
void	setEditable(boolean b)
void	setLabel(String label) Sets the descriptive label appearing above the text (not the title).
void	setMenuItems() Determines for each menu item whether to be enabled or disabled ("gray'ed out" )
void	setOptionPanel(JPanel optionPane) Allows subclasses to add their own option panel to the form without inconvenience.
void	setSuggestedFile(File suggestedFile) Sets the suggested file path in case the user wants to save.
void	setTextFont(Font f) Sets up the given font for the text display part of the frame only.
void	setTheText(String text)
private void	setup(JFrame owner, String title, String label, String text, File suggestedFile)
private void	theTextCaretUpdate(CaretEvent evt)

Methods inherited from class 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 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 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, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class 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 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class Object

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

Methods inherited from interface MenuContainer

getFont, postEvent

Field Detail

ownerFrame

JFrame ownerFrame

fullPathFile

File fullPathFile

editable

boolean editable

editMenu

private JMenu editMenu

fileMenu

private JMenu fileMenu

jMenuBar1

private JMenuBar jMenuBar1

mainLabel

public JLabel mainLabel

menuEditClear

private JMenuItem menuEditClear

menuEditCopy

private JMenuItem menuEditCopy

menuEditCut

private JMenuItem menuEditCut

menuEditPaste

private JMenuItem menuEditPaste

menuEditSelectAll

private JMenuItem menuEditSelectAll

menuFileClose

private JMenuItem menuFileClose

menuFileSave

private JMenuItem menuFileSave

optionPanel

public JPanel optionPanel

scroller

protected JScrollPane scroller

theText

public JEditorPane theText

windowMenu

private JMenu windowMenu

Constructor Detail

GenericTextFrame

public GenericTextFrame(JFrame owner)

Creates new form GenericTextFrame

GenericTextFrame

public GenericTextFrame(JFrame owner,
                        String title,
                        String label,
                        String text,
                        File suggestedFile)

Creates a new TextDisplayFrame with no text in it; use setText to fill it. The frame is not visible; this gives a chance to set various characteristics before showing it.

Parameters:

owner - the frame which spawned this one

title - the window's title

label - a descriptive header label (not the window title)

text - the text to be included in the text area

suggestedFile - a file to save the text to (null if not used)

Method Detail

setOptionPanel

public void setOptionPanel(JPanel optionPane)

Allows subclasses to add their own option panel to the form without inconvenience. The panel must use GroupLayout?

Parameters:

optionPane - The new panel to be added just above the text area.

setup

private void setup(JFrame owner,
                   String title,
                   String label,
                   String text,
                   File suggestedFile)

getTheText

public String getTheText()

setTheText

public void setTheText(String text)

setLabel

public void setLabel(String label)

Sets the descriptive label appearing above the text (not the title). Can be changed at any time.

Parameters:

label - the label to be displayed.

setEditable

public void setEditable(boolean b)

setSuggestedFile

public void setSuggestedFile(File suggestedFile)

Sets the suggested file path in case the user wants to save. Can be changed at any time. Invokes a dialog where the user can change it too.

Parameters:

suggestedFile - a reasonably named file to start the user off.

loadFile

public void loadFile()
              throws FileNotFoundException,
                     IOException

Read the frame's suggested file into the frame's text area for editing. Relies entirely on the correctness of the suggested file associated with the frame; if something goes wrong, exceptions are thrown.

Throws:

FileNotFoundException

IOException

setTextFont

public void setTextFont(Font f)

Sets up the given font for the text display part of the frame only.

Parameters:

f - the font to be displayed.

setContentType

public void setContentType(String type)

setMenuItems

public void setMenuItems()

Determines for each menu item whether to be enabled or disabled ("gray'ed out" )

getMenuItemLabel

public String getMenuItemLabel()

Tells a window manager what label to put on the menu to select this window

Specified by:

getMenuItemLabel in interface ManagedWindow

getFilename

public String getFilename()

If there's a file associated with the window, return its name; null otherwise.

Specified by:

getFilename in interface ManagedWindow

getWindowMenu

public JMenu getWindowMenu()

Description copied from interface: ManagedWindow

The window menu to be populated by the window manager.

Specified by:

getWindowMenu in interface ManagedWindow

Returns:

the managed window's menu to be populated. The menu cannot be null; however, the managed window itself may choose not to add it to the menu bar.

lostOwnership

public void lostOwnership(Clipboard clipboard,
                          Transferable contents)

Specified by:

lostOwnership in interface ClipboardOwner

initComponents

private void initComponents()

This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.

menuFileCloseActionPerformed

private void menuFileCloseActionPerformed(ActionEvent evt)

menuEditClearActionPerformed

private void menuEditClearActionPerformed(ActionEvent evt)

menuEditCopyActionPerformed

private void menuEditCopyActionPerformed(ActionEvent evt)

menuEditSelectAllActionPerformed

private void menuEditSelectAllActionPerformed(ActionEvent evt)

menuFileSaveActionPerformed

private void menuFileSaveActionPerformed(ActionEvent evt)

menuEditCutActionPerformed

private void menuEditCutActionPerformed(ActionEvent evt)

formWindowClosing

private void formWindowClosing(WindowEvent evt)

theTextCaretUpdate

private void theTextCaretUpdate(CaretEvent evt)

formComponentResized

private void formComponentResized(ComponentEvent evt)