Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## ccl.swing
Class MainJFrame

    java.lang.Object
      |
      +--java.awt.Component
            |
            +--java.awt.Container
                  |
                  +--java.awt.Window
                        |
                        +--java.awt.Frame
                              |
                              +--javax.swing.JFrame
                                    |
                                    +--ccl.swing.ExitJFrame
                                          |
                                          +--ccl.swing.MainJFrame

All Implemented Interfaces:
  javax.accessibility.Accessible, java.awt.event.ActionListener, javax.swing.event.ChangeListener, java.util.EventListener, Exitable, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.lang.Runnable, java.io.Serializable, javax.swing.WindowConstants, java.awt.event.WindowListener

public class MainJFrame
extends ExitJFrame
implements java.lang.Runnable, java.awt.event.ActionListener, javax.swing.event.ChangeListener

MainJFrame can be used to inherit you applications main frame class from, which would act as a controller and view of your application.

See Also:
  Serialized Form

Nested Class Summary
`static class` | `MainJFrame.CCLMetalTheme` A class representing a swing theme used by default for the ccl library.

Field Summary
`static java.lang.String` | `S_DOC_DIR` Directory used by default for documentation.

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
`MainJFrame()`
`MainJFrame(java.lang.String sTitle_)`
`MainJFrame(java.lang.String[] asArg_, java.lang.String sRcsHeader_)`
`MainJFrame(java.lang.String sTitle_, java.lang.String[] asArg_, java.lang.String sRcsHeader_)`
`MainJFrame(java.lang.String sTitle_, java.lang.String[] asArg_, java.lang.String sRcsHeader_, java.lang.String sIniFile_)`

Method Summary
`protected void` | `_backup(java.lang.String sFileName_)`
`protected boolean` | `_confirmClose()`
`protected java.lang.String` | `_getProjectSuffix()` You can overwrite this method to return a default project file suffix even if the ini file is missing.
`protected boolean` | `_isQuitGuardOK()` Deprecated. #_confirmClose
`void` | `actionPerformed(java.awt.event.ActionEvent pActionEvent_)`
`javax.help.HelpBroker` | `getHelpBroker()` Returns the Java Help broker object.
`Init` | `getInit()`
`void` | `initialize(java.lang.String[] asArg_, java.lang.String sInfoHeader_)`
`void` | `initialize(java.lang.String sTitle_, java.lang.String[] asArg_, java.lang.String sRcsHeader_)`
`void` | `initialize(java.lang.String sTitle_, java.lang.String[] asArg_, java.lang.String sRcsHeader_, java.lang.String sIniFileContent_)`
`void` | `interrupt()`
`boolean` | `isBusy()` Returns true if the application is busy with some task like saving right now.
`protected boolean` | `isExitSet()`
`boolean` | `isModified()`
`void` | `newFile()`
`void` | `open()` Interactively open new file/project.
`void` | `open(java.lang.String sProjectFileName_)` If you overwrite this method, it should invoke super.open( filename ) at the end.
`void` | `openOldProject(java.lang.String sOldProjectName_)`
`void` | `run()`
`void` | `runAction(RunnableAction pRunnableAction_)`
`protected void` | `runHook()`
`void` | `save()`
`void` | `save(java.lang.String sFileName_)` This is the method the user must implement.
`void` | `saveAs()`
`void` | `setBackground(java.awt.Color pColor_)`
`void` | `setBusy(boolean busy)` Turns on the hour glass mouse cursor and disables all mouse and keyboard events of the main frame.
`void` | `setExit()`
`void` | `setMenuBar(java.util.Vector vMenus_)`
`void` | `setModified(boolean bModified_)`
`void` | `setTitle()`
`void` | `start()`
`void` | `stateChanged(javax.swing.event.ChangeEvent pChangeEvent_)`
`void` | `stop()`
`void` | `updateMenu()`
`void` | `windowClosing(java.awt.event.WindowEvent event)`

Methods inherited from class ccl.swing.ExitJFrame
`exit, windowActivated, windowClosed, windowDeactivated, windowDeiconified, windowIconified, windowOpened`

Methods inherited from class javax.swing.JFrame
`addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update`

Methods inherited from class java.awt.Frame
`addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, 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, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle`

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface java.awt.MenuContainer
`getFont, postEvent`

Field Detail

### S_DOC_DIR

    public static final java.lang.String S_DOC_DIR

  Directory used by default for documentation. Ccl lib uses 'doc' for this, thought more and more projects seem to choose 'docs' instead.

  See Also:
    Constant Field Values

Constructor Detail

### MainJFrame

    public MainJFrame()

### MainJFrame

    public MainJFrame(java.lang.String sTitle_)

### MainJFrame

    public MainJFrame(java.lang.String[] asArg_,
                      java.lang.String sRcsHeader_)

### MainJFrame

    public MainJFrame(java.lang.String sTitle_,
                      java.lang.String[] asArg_,
                      java.lang.String sRcsHeader_)

### MainJFrame

    public MainJFrame(java.lang.String sTitle_,
                      java.lang.String[] asArg_,
                      java.lang.String sRcsHeader_,
                      java.lang.String sIniFile_)

Method Detail

### setBusy

    public void setBusy(boolean busy)

  Turns on the hour glass mouse cursor and disables all mouse and keyboard events of the main frame.

### isBusy

    public boolean isBusy()

  Returns true if the application is busy with some task like saving right now. This has some impact, for example exit will not work while the application is busy.

### initialize

    public void initialize(java.lang.String[] asArg_,
                           java.lang.String sInfoHeader_)

### initialize

    public void initialize(java.lang.String sTitle_,
                           java.lang.String[] asArg_,
                           java.lang.String sRcsHeader_)

### initialize

    public void initialize(java.lang.String sTitle_,
                           java.lang.String[] asArg_,
                           java.lang.String sRcsHeader_,
                           java.lang.String sIniFileContent_)

### setMenuBar

    public void setMenuBar(java.util.Vector vMenus_)

### updateMenu

    public void updateMenu()

### runAction

    public void runAction(RunnableAction pRunnableAction_)

### runHook

    protected void runHook()

### getInit

    public Init getInit()

### run

    public void run()

  Specified by:
    `run` in interface `java.lang.Runnable`

### start

    public void start()

### stop

    public void stop()

### actionPerformed

    public void actionPerformed(java.awt.event.ActionEvent pActionEvent_)

  Specified by:
    `actionPerformed` in interface `java.awt.event.ActionListener`

### getHelpBroker

    public javax.help.HelpBroker getHelpBroker()

  Returns the Java Help broker object. This can be used to register a Java Help broker object in this main frame.

### setExit

    public void setExit()

  Specified by:
    `setExit` in interface `Exitable`
  Overrides:
    `setExit` in class `ExitJFrame`

### isExitSet

    protected boolean isExitSet()

### windowClosing

    public void windowClosing(java.awt.event.WindowEvent event)

  Specified by:
    `windowClosing` in interface `java.awt.event.WindowListener`
  Overrides:
    `windowClosing` in class `ExitJFrame`

### setBackground

    public void setBackground(java.awt.Color pColor_)

  Overrides:
    `setBackground` in class `java.awt.Component`

### interrupt

    public void interrupt()

### setModified

    public void setModified(boolean bModified_)

### newFile

    public void newFile()

### open

    public void open()

  Interactively open new file/project.

### open

    public void open(java.lang.String sProjectFileName_)

  If you overwrite this method, it should invoke super.open( filename ) at the end.

### openOldProject

    public void openOldProject(java.lang.String sOldProjectName_)

### _backup

    protected void _backup(java.lang.String sFileName_)

### save

    public void save()

### _getProjectSuffix

    protected java.lang.String _getProjectSuffix()

  You can overwrite this method to return a default project file suffix even if the ini file is missing.

### saveAs

    public void saveAs()

### save

    public void save(java.lang.String sFileName_)

  This is the method the user must implement. User has not to take care of setting saved flag etc.

### _confirmClose

    protected boolean _confirmClose()

### _isQuitGuardOK

    protected boolean _isQuitGuardOK()

  Deprecated. #_confirmClose

### stateChanged

    public void stateChanged(javax.swing.event.ChangeEvent pChangeEvent_)

  Specified by:
    `stateChanged` in interface `javax.swing.event.ChangeListener`

### setTitle

    public void setTitle()

### isModified

    public boolean isModified()

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD