com.elsid.trellis
Class BaseModule

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JInternalFrame
                          |
                          +--com.elsid.trellis.BaseModule
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class BaseModule
extends javax.swing.JInternalFrame

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JInternalFrame
javax.swing.JInternalFrame.AccessibleJInternalFrame, javax.swing.JInternalFrame.JDesktopIcon
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Field Summary
static int ALT_KEY
           
 Trellis base_gui
           
static int CTRL_KEY
           
 javax.swing.JMenuBar menu_bar
           
 MenuDesc menu_desc
           
static int SHIFT_KEY
           
 javax.swing.JToolBar tool_bar
           
 ToolDesc tool_desc
           
 
Fields inherited from class javax.swing.JInternalFrame
closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY
 
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 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
BaseModule(Trellis base_gui)
           
 
Method Summary
 void addConsoleMessage(java.lang.String message)
          
 void addData(java.lang.Object key, java.lang.Object data)
          
 void addMenuItem(java.lang.String menu, java.lang.String item, java.lang.String action)
          
 boolean addMenuItemAccelarator(java.lang.String menu_name, java.lang.String item_name, char key, int modifier)
           This method assigns an accelerator character to a given menu item.
 boolean addMenuItemMnemonic(java.lang.String menu_name, java.lang.String item_name, char mnemonic)
          
 boolean addMenuMnemonic(java.lang.String menu_name, char mnemonic)
          
 void addMenuSeparator(java.lang.String menu)
          
 void addTool(java.lang.String image_file, java.lang.String action)
          
 void addTool(java.lang.String image_file, java.lang.String action, java.lang.String name)
          
 void addToolSeparator()
          
 void doAbout()
          
 void doClose()
          
 void doCopy()
          
 void doCut()
          
 void doHelp()
          
 void doLocalMenuCommand(java.lang.String action_connamd)
          
 void doNew()
          
 void doOpen()
          
 FileData doOpenReadText(java.lang.String file_name)
          
 void doPaste()
          
 void doSave()
          
 void doSaveAs()
          
 boolean doSaveWriteText(java.lang.String file_name, java.lang.String text, int mode)
          
 void doWhenActivated()
          
 void doWhenClosed()
          
 void doWhenClosing()
          
 void doWhenDeactivated()
          
 void enableBasicMenus(boolean enable)
          
 void enableBasicTools(boolean enable)
          
 void enableMenu(java.lang.String menu_name, boolean enable)
          
 void enableMenuItemAction(java.lang.String menu, java.lang.String action, boolean enable)
          
 void enableMenuItemName(java.lang.String menu_name, java.lang.String item_name, boolean enable)
          
 void enableToolAction(java.lang.String action, boolean enable)
          
 void finalize()
           
 java.lang.String getClipboardString()
          
 java.lang.Object getData(java.lang.Object key)
          
 void initMenuBar()
          
 void initToolBar()
          
 void removeData(java.lang.Object key)
          
 void setClipboardString(java.lang.String str)
          
 void setStatusMessage(java.lang.String message)
          
 
Methods inherited from class javax.swing.JInternalFrame
addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusOwner, getFrameIcon, getGlassPane, getJMenuBar, getLayer, getLayeredPane, getMenuBar, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, isClosable, isClosed, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setDefaultCloseOperation, setDesktopIcon, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, 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, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SHIFT_KEY

public static final int SHIFT_KEY

CTRL_KEY

public static final int CTRL_KEY

ALT_KEY

public static final int ALT_KEY

base_gui

public Trellis base_gui

menu_bar

public javax.swing.JMenuBar menu_bar

menu_desc

public MenuDesc menu_desc

tool_bar

public javax.swing.JToolBar tool_bar

tool_desc

public ToolDesc tool_desc
Constructor Detail

BaseModule

public BaseModule(Trellis base_gui)
Method Detail

finalize

public void finalize()
Overrides:
finalize in class java.lang.Object

doSaveWriteText

public final boolean doSaveWriteText(java.lang.String file_name,
                                     java.lang.String text,
                                     int mode)
Parameters:
String - file_name
String - text
int - mode
    Trellis.SAVE Trellis.SAVE_AS
Returns:
boolean

doOpenReadText

public final FileData doOpenReadText(java.lang.String file_name)
Parameters:
String - file_name
Returns:
FileData object or null

addConsoleMessage

public final void addConsoleMessage(java.lang.String message)
Parameters:
String - message

addToolSeparator

public void addToolSeparator()

addTool

public final void addTool(java.lang.String image_file,
                          java.lang.String action)
Parameters:
String - image_file
String - action

addTool

public final void addTool(java.lang.String image_file,
                          java.lang.String action,
                          java.lang.String name)
Parameters:
String - image_file
String - action
String - name

enableToolAction

public final void enableToolAction(java.lang.String action,
                                   boolean enable)
Parameters:
String - action
boolean - enable
Returns:
boolean

initToolBar

public void initToolBar()

enableBasicTools

public void enableBasicTools(boolean enable)
Parameters:
boolean - enable

addMenuSeparator

public void addMenuSeparator(java.lang.String menu)
Parameters:
String - menu

addMenuItem

public final void addMenuItem(java.lang.String menu,
                              java.lang.String item,
                              java.lang.String action)
Parameters:
String - menu
String - item
String - action

initMenuBar

public final void initMenuBar()

enableMenu

public final void enableMenu(java.lang.String menu_name,
                             boolean enable)
Parameters:
String - menu_name
boolean - enable

enableMenuItemName

public final void enableMenuItemName(java.lang.String menu_name,
                                     java.lang.String item_name,
                                     boolean enable)
Parameters:
String - menu_name
String - item_name
boolean - enable

enableMenuItemAction

public final void enableMenuItemAction(java.lang.String menu,
                                       java.lang.String action,
                                       boolean enable)
Parameters:
String - menue
String - action
boolean - enable

enableBasicMenus

public void enableBasicMenus(boolean enable)
Parameters:
boolean - enable

addMenuItemAccelarator

public boolean addMenuItemAccelarator(java.lang.String menu_name,
                                      java.lang.String item_name,
                                      char key,
                                      int modifier)

This method assigns an accelerator character to a given menu item. In addition to the accelerator character a modifier may be assigned to the accelerator key.

Parameters:
String - menu_name
String - item_name
char - key
int - modifier
  • Trellis.ALT_KEY
  • Trellis.CTRL_KEY
  • Trellis.SHIFT_KEY
Returns:
boolean

addMenuItemMnemonic

public boolean addMenuItemMnemonic(java.lang.String menu_name,
                                   java.lang.String item_name,
                                   char mnemonic)
Parameters:
String - menu_name
String - item_name
char - mnemonic
Returns:
boolean

addMenuMnemonic

public boolean addMenuMnemonic(java.lang.String menu_name,
                               char mnemonic)
Parameters:
String - menu_name
char - mnemonic
Returns:
boolean

setStatusMessage

public final void setStatusMessage(java.lang.String message)
Parameters:
String - message

getClipboardString

public final java.lang.String getClipboardString()
Returns:
String
Throws:
-  

setClipboardString

public final void setClipboardString(java.lang.String str)
Parameters:
String - str

addData

public final void addData(java.lang.Object key,
                          java.lang.Object data)
Parameters:
Object - key
Object - data

removeData

public final void removeData(java.lang.Object key)
Parameters:
Object - key

getData

public final java.lang.Object getData(java.lang.Object key)
Parameters:
Object - key
Returns:
Object

doWhenActivated

public void doWhenActivated()

doWhenDeactivated

public void doWhenDeactivated()

doWhenClosing

public void doWhenClosing()

doWhenClosed

public void doWhenClosed()

doClose

public void doClose()

doNew

public void doNew()

doOpen

public void doOpen()

doSave

public void doSave()

doSaveAs

public void doSaveAs()

doCut

public void doCut()

doCopy

public void doCopy()

doPaste

public void doPaste()

doHelp

public void doHelp()

doAbout

public void doAbout()

doLocalMenuCommand

public void doLocalMenuCommand(java.lang.String action_connamd)