XJFrame (ANTLRWorks 1.5.2 API)

java.lang.Object
- org.antlr.xjlib.foundation.XJObject
- - org.antlr.xjlib.appkit.XJControl
  - - org.antlr.xjlib.appkit.frame.XJFrame

All Implemented Interfaces:

XJMenuBarCustomizer, XJMenuBarDelegate

Direct Known Subclasses:

XJWindow
```
public class XJFrame
extends XJControl
implements XJMenuBarCustomizer, XJMenuBarDelegate
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`alreadyBecomeVisible`
`protected XJFrameDelegate`	`delegate`
`protected static XJMainMenuBar`	`desktopDefaultMenuBar`
`protected static JFrame`	`desktopFrame`
`protected boolean`	`dirty`
`protected XJMainMenuBar`	`mainMenuBar`
`protected XJUndoEngine`	`undoEngine`

Constructor Summary

Constructors
Constructor and Description

XJFrame()

Constructors
Constructor and Description
`XJFrame()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`autosaveName()`
`void`	`awake()`
`void`	`becomingVisibleForTheFirstTime()`
`void`	`bringToFront()`
`void`	`center()`
`protected boolean`	`close(boolean force)`
`static void`	`closeDesktop()`
`void`	`customizeEditMenu(XJMenu menu)`
`void`	`customizeFileMenu(XJMenu menu)`
`void`	`customizeHelpMenu(XJMenu menu)`
`void`	`customizeMenuBar(XJMainMenuBar menubar)`
`void`	`customizeWindowMenu(XJMenu menu)`
`boolean`	`dirty()`
`void`	`dirtyChanged()`
`void`	`ensureVisibility()` Ensures that the window is visible in one of the available screen.
`Container`	`getContentPane()`
`XJUndo`	`getCurrentUndo()`
`XJFrameDelegate`	`getDelegate()`
`static JComponent`	`getFocusedJComponent()`
`Component`	`getGlassPane()`
`Container`	`getJavaContainer()`
`JLayeredPane`	`getLayeredPane()`
`Point`	`getLocation()`
`XJMainMenuBar`	`getMainMenuBar()`
`Dimension`	`getPreferredSize()`
`JRootPane`	`getRootPane()`
`Dimension`	`getSize()`
`String`	`getTitle()`
`XJUndo`	`getUndo(JTextPane textPane)`
`void`	`handleMenuEvent(XJMenu menu, XJMenuItem item)`
`void`	`handleMenuSelected(XJMenu menu)`
`void`	`hide()`
`boolean`	`isActive()`
`boolean`	`isCompletelyOnScreen()`
`boolean`	`isMaximized()`
`boolean`	`isVisible()`
`boolean`	`isVisibleOnScreen()`
`void`	`menuItemState(XJMenuItem item)`
`void`	`menuItemStatusChanged(int tag)`
`void`	`offsetPosition(int dx, int dy)`
`void`	`pack()`
`static void`	`performActionOnFocusedJComponent(String action)`
`boolean`	`performClose(boolean force)`
`void`	`performRedo()`
`void`	`performUndo()`
`void`	`registerUndo(XJUndoDelegate delegate, JTextPane textPane)`
`void`	`resetDirty()`
`void`	`setDefaultCloseOperation(int operation)`
`void`	`setDefaultSize()`
`void`	`setDelegate(XJFrameDelegate delegate)`
`void`	`setDirty()`
`void`	`setLocation(Point loc)`
`void`	`setMainMenuBar(XJMainMenuBar menubar)`
`void`	`setMaximizable(boolean flag)`
`void`	`setPosition(int x, int y)`
`void`	`setPreferredSize(Dimension size)`
`void`	`setPreferredSize(int dx, int dy)`
`void`	`setResizable(boolean flag)`
`void`	`setSize(Dimension size)`
`void`	`setSize(int dx, int dy)`
`void`	`setTitle(String title)`
`void`	`setVisible(boolean flag)`
`boolean`	`shouldAppearsInWindowMenu()`
`boolean`	`shouldDisplayMainMenuBar()`
`void`	`show()`
`void`	`showModal()`
`void`	`unregisterUndo(XJUndoDelegate delegate)`
`void`	`updateTitle()`
`void`	`windowActivated()`
`void`	`windowDeactivated()`

Methods inherited from class org.antlr.xjlib.appkit.XJControl
keyValueChanged, setEnableKeyValueNotification

Methods inherited from class org.antlr.xjlib.foundation.XJObject
addObserver, addObserverForKey, bindObserverForKey, keyValueChanged, observeValueForKey, removeObserver, removeObserverForKey

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

Field Detail

desktopFrame
```
protected static JFrame desktopFrame
```

desktopDefaultMenuBar

protected static XJMainMenuBar desktopDefaultMenuBar

mainMenuBar
```
protected XJMainMenuBar mainMenuBar
```

delegate
```
protected XJFrameDelegate delegate
```

undoEngine
```
protected XJUndoEngine undoEngine
```

alreadyBecomeVisible
```
protected boolean alreadyBecomeVisible
```

dirty
```
protected boolean dirty
```

Constructor Detail
- XJFrame
```
public XJFrame()
```

Method Detail

closeDesktop
```
public static void closeDesktop()
```

awake
```
public void awake()
```
Overrides:

awake in class XJObject

setDelegate

public void setDelegate(XJFrameDelegate delegate)

getDelegate
```
public XJFrameDelegate getDelegate()
```

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)

getContentPane
```
public Container getContentPane()
```

getRootPane
```
public JRootPane getRootPane()
```

getLayeredPane
```
public JLayeredPane getLayeredPane()
```

getGlassPane
```
public Component getGlassPane()
```

setMainMenuBar

public void setMainMenuBar(XJMainMenuBar menubar)

getMainMenuBar
```
public XJMainMenuBar getMainMenuBar()
```

menuItemStatusChanged

public void menuItemStatusChanged(int tag)

setTitle
```
public void setTitle(String title)
```

getTitle
```
public String getTitle()
```

updateTitle
```
public void updateTitle()
```

setLocation
```
public void setLocation(Point loc)
```

getLocation
```
public Point getLocation()
```

setSize

public void setSize(int dx,
           int dy)

setPreferredSize

public void setPreferredSize(int dx,
                    int dy)

setPreferredSize

public void setPreferredSize(Dimension size)

getPreferredSize
```
public Dimension getPreferredSize()
```

setSize
```
public void setSize(Dimension size)
```

getSize
```
public Dimension getSize()
```

setDefaultSize
```
public void setDefaultSize()
```

setResizable

public void setResizable(boolean flag)

setMaximizable

public void setMaximizable(boolean flag)

isMaximized
```
public boolean isMaximized()
```

pack
```
public void pack()
```

bringToFront
```
public void bringToFront()
```

setVisible
```
public void setVisible(boolean flag)
```

ensureVisibility
```
public void ensureVisibility()
```
Ensures that the window is visible in one of the available screen. Otherwise, move it to the center of the main screen.

becomingVisibleForTheFirstTime

public void becomingVisibleForTheFirstTime()

autosaveName
```
public String autosaveName()
```

isVisible
```
public boolean isVisible()
```

isActive
```
public boolean isActive()
```

show
```
public void show()
```

showModal
```
public void showModal()
```

hide
```
public void hide()
```

isCompletelyOnScreen
```
public boolean isCompletelyOnScreen()
```

isVisibleOnScreen
```
public boolean isVisibleOnScreen()
```

center
```
public void center()
```

setPosition

public void setPosition(int x,
               int y)

offsetPosition

public void offsetPosition(int dx,
                  int dy)

performClose

public boolean performClose(boolean force)

close

protected boolean close(boolean force)

setDirty
```
public void setDirty()
```

resetDirty
```
public void resetDirty()
```

dirtyChanged
```
public void dirtyChanged()
```

dirty
```
public boolean dirty()
```

registerUndo

public void registerUndo(XJUndoDelegate delegate,
                JTextPane textPane)

unregisterUndo

public void unregisterUndo(XJUndoDelegate delegate)

performUndo
```
public void performUndo()
```

performRedo
```
public void performRedo()
```

getUndo

public XJUndo getUndo(JTextPane textPane)

getCurrentUndo
```
public XJUndo getCurrentUndo()
```

shouldDisplayMainMenuBar

public boolean shouldDisplayMainMenuBar()

shouldAppearsInWindowMenu

public boolean shouldAppearsInWindowMenu()

windowActivated
```
public void windowActivated()
```

windowDeactivated
```
public void windowDeactivated()
```

customizeFileMenu
```
public void customizeFileMenu(XJMenu menu)
```
Specified by:

customizeFileMenu in interface XJMenuBarCustomizer

customizeEditMenu
```
public void customizeEditMenu(XJMenu menu)
```
Specified by:

customizeEditMenu in interface XJMenuBarCustomizer

customizeWindowMenu
```
public void customizeWindowMenu(XJMenu menu)
```
Specified by:

customizeWindowMenu in interface XJMenuBarCustomizer

customizeHelpMenu
```
public void customizeHelpMenu(XJMenu menu)
```
Specified by:

customizeHelpMenu in interface XJMenuBarCustomizer

customizeMenuBar
```
public void customizeMenuBar(XJMainMenuBar menubar)
```
Specified by:

customizeMenuBar in interface XJMenuBarCustomizer

menuItemState
```
public void menuItemState(XJMenuItem item)
```
Specified by:

menuItemState in interface XJMenuBarDelegate

handleMenuEvent

public void handleMenuEvent(XJMenu menu,
                   XJMenuItem item)

Specified by:: handleMenuEvent in interface XJMenuBarDelegate

handleMenuSelected
```
public void handleMenuSelected(XJMenu menu)
```
Specified by:

handleMenuSelected in interface XJMenuBarDelegate

performActionOnFocusedJComponent

public static void performActionOnFocusedJComponent(String action)

getFocusedJComponent

public static JComponent getFocusedJComponent()

getJavaContainer
```
public Container getJavaContainer()
```

Class XJFrame

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.antlr.xjlib.appkit.XJControl

Methods inherited from class org.antlr.xjlib.foundation.XJObject

Methods inherited from class java.lang.Object

Field Detail

desktopFrame

desktopDefaultMenuBar

mainMenuBar

delegate

undoEngine

alreadyBecomeVisible

dirty

Constructor Detail

XJFrame

Method Detail

closeDesktop

awake

setDelegate

getDelegate

setDefaultCloseOperation

getContentPane

getRootPane

getLayeredPane

getGlassPane

setMainMenuBar

getMainMenuBar

menuItemStatusChanged

setTitle

getTitle

updateTitle

setLocation

getLocation

setSize

setPreferredSize

setPreferredSize

getPreferredSize

setSize

getSize

setDefaultSize

setResizable

setMaximizable

isMaximized

pack

bringToFront

setVisible

ensureVisibility

becomingVisibleForTheFirstTime

autosaveName

isVisible

isActive

show

showModal

hide

isCompletelyOnScreen

isVisibleOnScreen

center

setPosition

offsetPosition

performClose

close

setDirty

resetDirty

dirtyChanged

dirty

registerUndo

unregisterUndo

performUndo

performRedo

getUndo

getCurrentUndo

shouldDisplayMainMenuBar

shouldAppearsInWindowMenu

windowActivated

windowDeactivated

customizeFileMenu

customizeEditMenu

customizeWindowMenu