org.jdesktop.swingx
Class JXFrame

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Frame
                  extended by javax.swing.JFrame
                      extended by org.jdesktop.swingx.JXFrame
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
Direct Known Subclasses:
JXLoginPane.JXLoginFrame

public class JXFrame
extends javax.swing.JFrame

A smarter JFrame specifically used for top level frames for Applications. This frame uses a JXRootPane.

See Also:
Serialized Form

Nested Class Summary
static class JXFrame.StartPosition
           
 
Nested classes/interfaces inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Nested classes/interfaces inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
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
JXFrame()
           
JXFrame(java.lang.String title)
           
JXFrame(java.lang.String title, boolean exitOnClose)
           
 
Method Summary
protected  javax.swing.JRootPane createRootPane()
          Overloaded to create a JXRootPane.
 javax.swing.JButton getCancelButton()
           
 javax.swing.JButton getDefaultButton()
           
 long getIdleThreshold()
           
 boolean getKeyPreview()
           
 JXRootPane getRootPaneExt()
          Return the extended root pane.
 JXFrame.StartPosition getStartPosition()
           
 JXStatusBar getStatusBar()
           
 javax.swing.JToolBar getToolBar()
           
 java.awt.Component getWaitPane()
           
 boolean isIdle()
           
 boolean isWaitCursorVisible()
           
 boolean isWaiting()
           
 boolean isWaitPaneVisible()
           
 void setCancelButton(javax.swing.JButton button)
           
 void setCursor(java.awt.Cursor c)
           
 void setDefaultButton(javax.swing.JButton button)
           
 void setIdle(boolean idle)
           
 void setIdleThreshold(long threshold)
           
 void setKeyPreview(boolean flag)
           
 void setRootPane(javax.swing.JRootPane root)
          Overloaded to make this public.
 void setStartPosition(JXFrame.StartPosition position)
           
 void setStatusBar(JXStatusBar statusBar)
           
 void setToolBar(javax.swing.JToolBar toolBar)
           
 void setVisible(boolean visible)
           
 void setWaitCursorVisible(boolean flag)
           
 void setWaiting(boolean waiting)
           
 void setWaitPane(java.awt.Component c)
           
 void setWaitPaneVisible(boolean flag)
           
 
Methods inherited from class javax.swing.JFrame
addImpl, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, 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, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, transferFocusBackward, 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
 

Constructor Detail

JXFrame

public JXFrame()

JXFrame

public JXFrame(java.lang.String title,
               boolean exitOnClose)

JXFrame

public JXFrame(java.lang.String title)
Method Detail

setCancelButton

public void setCancelButton(javax.swing.JButton button)

getCancelButton

public javax.swing.JButton getCancelButton()

setDefaultButton

public void setDefaultButton(javax.swing.JButton button)

getDefaultButton

public javax.swing.JButton getDefaultButton()

setKeyPreview

public void setKeyPreview(boolean flag)

getKeyPreview

public final boolean getKeyPreview()

setStartPosition

public void setStartPosition(JXFrame.StartPosition position)

getStartPosition

public JXFrame.StartPosition getStartPosition()

setWaitCursorVisible

public void setWaitCursorVisible(boolean flag)

isWaitCursorVisible

public boolean isWaitCursorVisible()

setCursor

public void setCursor(java.awt.Cursor c)
Overrides:
setCursor in class java.awt.Window

setWaitPane

public void setWaitPane(java.awt.Component c)

getWaitPane

public java.awt.Component getWaitPane()

setWaitPaneVisible

public void setWaitPaneVisible(boolean flag)

isWaitPaneVisible

public boolean isWaitPaneVisible()

setWaiting

public void setWaiting(boolean waiting)

isWaiting

public boolean isWaiting()

setVisible

public void setVisible(boolean visible)
Overrides:
setVisible in class java.awt.Window

isIdle

public boolean isIdle()

setIdle

public void setIdle(boolean idle)

setIdleThreshold

public void setIdleThreshold(long threshold)

getIdleThreshold

public long getIdleThreshold()

setStatusBar

public void setStatusBar(JXStatusBar statusBar)

getStatusBar

public JXStatusBar getStatusBar()

setToolBar

public void setToolBar(javax.swing.JToolBar toolBar)

getToolBar

public javax.swing.JToolBar getToolBar()

createRootPane

protected javax.swing.JRootPane createRootPane()
Overloaded to create a JXRootPane.

Overrides:
createRootPane in class javax.swing.JFrame

setRootPane

public void setRootPane(javax.swing.JRootPane root)
Overloaded to make this public.

Overrides:
setRootPane in class javax.swing.JFrame

getRootPaneExt

public JXRootPane getRootPaneExt()
Return the extended root pane. If this frame doesn't contain an extended root pane the root pane should be accessed with getRootPane().

Returns:
the extended root pane or null.