org.activemath.author.toc
Class TOC

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.activemath.author.toc.TOC

All Implemented Interfaces:

ClipboardOwner, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class TOC
extends JFrame
implements ActionListener, ClipboardOwner

An activemath TOC-Edit Frame

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow

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

protected static int	CANCEL
protected boolean	changesSaved
protected static int	CLOSED
protected static int	NO
EditableTOCJTree	tree
protected static Vector	windowList
protected static int	YES

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

TOC()
Deprecated. this constructor provides no configuration and will fail

TOC(String fileName, Subconfiguration subconf)

TOC(String fileName, Subconfiguration subconf, String username, String sessionname, String bookname, String tocEditUrl)

Method Summary

void	actionPerformed_Copy(String srcData)
void	actionPerformed(ActionEvent e) responds to ActionEvents.
void	changed() sets the changesSaved flag to false.
void	closeWindow()
boolean	getChangesSaved()
Subconfiguration	getConfig()
DCMetaEditPanel	getContribPanel()
DCMetaEditPanel	getCreatorPanel()
String	getFileName()
IDEditPanel	getIdPanel()
JScrollPane	getScrollPane() returns the JScrollPane object that holds this TOC's JTree.
JTabbedPane	getTabbedPane()
DCMetaEditPanel	getTitlePanel()
EditableTOCJTree	getTree()
void	importSession() shwos a dialog that allows the user to enter session parameters.
void	lostOwnership(Clipboard clipboard, Transferable contents)
static void	main(String[] args) opens a single new TOC edit frame.
int	notYetSaved() gets on the user's nerves until the current file is saved or the operation is cancelled.
void	openFile() shows a dialog allowing the user to select a file to be loaded into this TOC edit frame.
void	popupMenu(MouseEvent e)
void	save()
boolean	saveFileAs() open file dialog in order to save current document. returns false if the user cancelled the process.
void	setAddOption(boolean b) toggles the Edit/Add command on or off.
void	setEditMenuEnable(boolean b) toggles cut/copy/paste options in editmenu on or off
void	setPasteAutomatic() toggles the Edit/Paste command on or off, depending on the value of cutnpastedata.
void	setPasteOption(boolean b) toggles the Edit/Paste command on or off.
void	shutdown()

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, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, 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, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, isOpaque, 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, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

YES

protected static final int YES

See Also:

Constant Field Values

NO

protected static final int NO

See Also:

Constant Field Values

CANCEL

protected static final int CANCEL

See Also:

Constant Field Values

CLOSED

protected static final int CLOSED

See Also:

Constant Field Values

windowList

protected static Vector windowList

tree

public EditableTOCJTree tree

changesSaved

protected boolean changesSaved

Constructor Detail

TOC

public TOC()

Deprecated. this constructor provides no configuration and will fail

Constructs a new TOC object with an empty tree and no session loaded.

TOC

public TOC(String fileName,
           Subconfiguration subconf,
           String username,
           String sessionname,
           String bookname,
           String tocEditUrl)

TOC

public TOC(String fileName,
           Subconfiguration subconf)

Method Detail

getFileName

public String getFileName()

main

public static void main(String[] args)

opens a single new TOC edit frame.

Parameters:

args - Missing description The command line arguments

setPasteOption

public void setPasteOption(boolean b)

toggles the Edit/Paste command on or off.

Parameters:

b - a flag indicating whether paste is available \ or not.

setPasteAutomatic

public void setPasteAutomatic()

toggles the Edit/Paste command on or off, depending on the value of cutnpastedata.

setAddOption

public void setAddOption(boolean b)

toggles the Edit/Add command on or off.

Parameters:

b - a flag indicating whether add is available \ or not.

setEditMenuEnable

public void setEditMenuEnable(boolean b)

toggles cut/copy/paste options in editmenu on or off

Parameters:

b - flag the indicates if cut/copy should be available.

getScrollPane

public JScrollPane getScrollPane()

returns the JScrollPane object that holds this TOC's JTree.

Returns:

Missing description of return The scrollPane value

getIdPanel

public IDEditPanel getIdPanel()

getTitlePanel

public DCMetaEditPanel getTitlePanel()

getCreatorPanel

public DCMetaEditPanel getCreatorPanel()

getContribPanel

public DCMetaEditPanel getContribPanel()

getTabbedPane

public JTabbedPane getTabbedPane()

getTree

public EditableTOCJTree getTree()

actionPerformed

public void actionPerformed(ActionEvent e)

responds to ActionEvents.

Specified by:

actionPerformed in interface ActionListener

Parameters:

e - the ActionEvent to be processed.

actionPerformed_Copy

public void actionPerformed_Copy(String srcData)

lostOwnership

public void lostOwnership(Clipboard clipboard,
                          Transferable contents)

Specified by:

lostOwnership in interface ClipboardOwner

save

public void save()

saveFileAs

public boolean saveFileAs()

open file dialog in order to save current document. returns false if the user cancelled the process.

Returns:

Missing description of the Returned Value

notYetSaved

public int notYetSaved()

gets on the user's nerves until the current file is saved or the operation is cancelled.

Returns:

Missing description of the Returned Value

openFile

public void openFile()

shows a dialog allowing the user to select a file to be loaded into this TOC edit frame.

getConfig

public Subconfiguration getConfig()

importSession

public void importSession()

shwos a dialog that allows the user to enter session parameters. That session is then tried to be loaded into this TOC edit frame.

closeWindow

public void closeWindow()

popupMenu

public void popupMenu(MouseEvent e)

shutdown

public void shutdown()

changed

public void changed()

sets the changesSaved flag to false.

getChangesSaved

public boolean getChangesSaved()