kiwi.ui
Class KFrame

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Frame
                  extended byjavax.swing.JFrame
                      extended bykiwi.ui.KFrame
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants
Direct Known Subclasses:
AboutFrame, ConsoleFrame, DocumentBrowserFrame

public class KFrame
extends javax.swing.JFrame

KFrame is a trivial extension of JFrame that provides support for tiling the background of the frame with an image.

The method getMainContainer() will return the frame's KPanel. Add child components to the frame by adding them to this KPanel.


An example KFrame.

Author:
Mark Lindner
See Also:
KPanel, Serialized Form

Nested Class Summary
private  class KFrame._PropertyChangeListener
           
private  class KFrame._WindowListener
           
 
Nested classes inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Nested classes inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
private  KPanel _content
           
private  KPanel _main
           
private  KFrame._PropertyChangeListener propListener
           
 
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.Window
 
Fields inherited from class java.awt.Container
 
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
KFrame()
          Construct a new KFrame.
KFrame(java.lang.String title)
          Construct a new KFrame.
 
Method Summary
protected  boolean canClose()
          Called in response to a frame close event to determine if this frame may be closed.
 void destroy()
          Destroy this frame.
 KPanel getMainContainer()
          Get a reference to the main container (in this case, the KPanel that is the child of the frame's content pane).
 void setBusyCursor(boolean flag)
          Turn the busy cursor on or off for this window.
 void setColor(java.awt.Color color)
          Set the background color.
 void setMenuBar(javax.swing.JMenuBar menuBar)
          Set the menu bar for the frame.
 void setStatusBar(StatusBar statusBar)
          Set the status bar for the frame.
 void setTexture(java.awt.Image image)
          Set the background texture.
 void setVisible(boolean flag)
          Show or hide the frame.
protected  void startFocus()
          This method is called when the frame is made visible; it should transfer focus to the appropriate child component.
 
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, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, 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

_main

private KPanel _main

_content

private KPanel _content

propListener

private KFrame._PropertyChangeListener propListener
Constructor Detail

KFrame

public KFrame()
Construct a new KFrame.


KFrame

public KFrame(java.lang.String title)
Construct a new KFrame.

Parameters:
title - The title for the frame.
Method Detail

setMenuBar

public void setMenuBar(javax.swing.JMenuBar menuBar)
Set the menu bar for the frame. Using this method rather than setJMenuBar() allows for the installation of a transparent menubar.

Parameters:
menuBar - The new menu bar.
Since:
Kiwi 1.3.3

setStatusBar

public void setStatusBar(StatusBar statusBar)
Set the status bar for the frame.

Parameters:
statusBar - the new status bar.
Since:
Kiwi 1.3.3

getMainContainer

public KPanel getMainContainer()
Get a reference to the main container (in this case, the KPanel that is the child of the frame's content pane).


setTexture

public void setTexture(java.awt.Image image)
Set the background texture.

Parameters:
image - The image to use as the background texture for the frame.

setColor

public void setColor(java.awt.Color color)
Set the background color.

Parameters:
color - The new background color.

canClose

protected boolean canClose()
Called in response to a frame close event to determine if this frame may be closed.

Returns:
true if the frame is allowed to close, and false otherwise. The default implementation returns true.

setVisible

public void setVisible(boolean flag)
Show or hide the frame.

Parameters:
flag - A flag specifying whether the frame should be shown or hidden. If true, the startFocus() method is called to allow the subclasser to request focus for a given child component.
See Also:
startFocus()

startFocus

protected void startFocus()
This method is called when the frame is made visible; it should transfer focus to the appropriate child component. The default implementation does nothing.


setBusyCursor

public void setBusyCursor(boolean flag)
Turn the busy cursor on or off for this window.

Parameters:
flag - If true, the wait cursor will be set for this window, otherwise the default cursor will be set.

destroy

public void destroy()
Destroy this frame. Call this method when the frame is no longer needed. The frame will detach its listeners from the UIChanageManager.