javax.swing.plaf.basic
Class BasicInternalFrameUI

java.lang.Object
  extended by javax.swing.plaf.ComponentUI
      extended by javax.swing.plaf.InternalFrameUI
          extended by javax.swing.plaf.basic.BasicInternalFrameUI
Direct Known Subclasses:
MetalInternalFrameUI

public class BasicInternalFrameUI
extends InternalFrameUI

This is the UI delegate for the Basic look and feel for JInternalFrames.


Nested Class Summary
protected  class BasicInternalFrameUI.BasicInternalFrameListener
          This is a helper class that listens to the JInternalFrame for InternalFrameEvents.
protected  class BasicInternalFrameUI.BorderListener
          This helper class listens to the edges of the JInternalFrame and the TitlePane for mouse events.
protected  class BasicInternalFrameUI.ComponentHandler
          This helper class listens to the JDesktopPane that parents this JInternalFrame and listens for resize events and resizes the JInternalFrame appropriately.
protected  class BasicInternalFrameUI.GlassPaneDispatcher
          This helper class is used to listen to the JDesktopPane's glassPane for MouseEvents.
 class BasicInternalFrameUI.InternalFrameLayout
          This helper class acts as the LayoutManager for JInternalFrames.
 class BasicInternalFrameUI.InternalFramePropertyChangeListener
          This helper class listens for PropertyChangeEvents from the JInternalFrame.
 
Field Summary
protected  MouseInputAdapter borderListener
          The MouseListener that is responsible for dragging and resizing the JInternalFrame in response to MouseEvents.
protected  ComponentListener componentListener
          The ComponentListener that is responsible for resizing the JInternalFrame in response to ComponentEvents from the JDesktopPane.
protected  JComponent eastPane
          The JComponent placed at the east region of the JInternalFrame.
protected  JInternalFrame frame
          The JInternalFrame this UI is responsible for.
protected  MouseInputListener glassPaneDispatcher
          The MouseListener that is responsible for activating the JInternalFrame when the mouse press activates one of its descendents.
protected  LayoutManager internalFrameLayout
          The LayoutManager used in the JInternalFrame.
protected  JComponent northPane
          The JComponent placed at the north region of the JInternalFrame.
protected  KeyStroke openMenuKey
          Deprecated.  
protected  PropertyChangeListener propertyChangeListener
          The PropertyChangeListener that is responsible for listening to PropertyChangeEvents from the JInternalFrame.
protected  JComponent southPane
          The JComponent placed at the south region of the JInternalFrame.
protected  BasicInternalFrameTitlePane titlePane
          The TitlePane displayed at the top of the JInternalFrame.
protected  JComponent westPane
          The JComponent placed at the west region of the JInternalFrame.
 
Constructor Summary
BasicInternalFrameUI(JInternalFrame b)
          Creates a new BasicInternalFrameUI object.
 
Method Summary
protected  void activateFrame(JInternalFrame f)
          This is a convenience method that activates the JInternalFrame.
protected  void closeFrame(JInternalFrame f)
          This is a convenience method that closes the JInternalFrame.
protected  MouseInputAdapter createBorderListener(JInternalFrame w)
          This method returns a new BorderListener for the given JInternalFrame.
protected  ComponentListener createComponentListener()
          This method returns a new ComponentListener for the JDesktopPane.
protected  DesktopManager createDesktopManager()
          This method returns a default DesktopManager that can be used with this JInternalFrame.
protected  JComponent createEastPane(JInternalFrame w)
          This method creates the east pane used in the JInternalFrame.
protected  MouseInputListener createGlassPaneDispatcher()
          This method returns a new GlassPaneDispatcher.
protected  void createInternalFrameListener()
          This method creates a new InternalFrameListener for the JInternalFrame.
protected  LayoutManager createLayoutManager()
          This method creates a new LayoutManager for the JInternalFrame.
protected  JComponent createNorthPane(JInternalFrame w)
          This method creates the north pane used in the JInternalFrame.
protected  PropertyChangeListener createPropertyChangeListener()
          This method creates a new PropertyChangeListener for the JInternalFrame.
protected  JComponent createSouthPane(JInternalFrame w)
          This method creates the south pane used in the JInternalFrame.
static ComponentUI createUI(JComponent b)
          This method will create a new BasicInternalFrameUI for the given JComponent.
protected  JComponent createWestPane(JInternalFrame w)
          This method creates the west pane used in the JInternalFrame.
protected  void deactivateFrame(JInternalFrame f)
          This is a convenience method that deactivates the JInternalFrame.
protected  void deiconifyFrame(JInternalFrame f)
          This is a convenience method that deiconifies the JInternalFrame.
protected  void deinstallMouseHandlers(JComponent c)
          This method removes the necessary MouseListeners from the given JComponent.
protected  DesktopManager getDesktopManager()
          This method returns the DesktopManager to use with the JInternalFrame.
 JComponent getEastPane()
          This method returns the east pane.
 Dimension getMaximumSize(JComponent x)
          This method returns the maximum size of the given JComponent.
 Dimension getMinimumSize(JComponent x)
          This method returns the minimum size of the given JComponent.
 JComponent getNorthPane()
          This method returns the north pane.
 Dimension getPreferredSize(JComponent x)
          This method returns the preferred size of the given JComponent.
 JComponent getSouthPane()
          This method returns the south pane.
 JComponent getWestPane()
          This method returns the west pane.
protected  void iconifyFrame(JInternalFrame f)
          This is a convenience method that iconifies the JInternalFrame.
protected  void installComponents()
          This method installs the Components for the JInternalFrame.
protected  void installDefaults()
          This method installs the defaults specified by the look and feel.
protected  void installKeyboardActions()
          This method installs the keyboard actions for the JInternalFrame.
protected  void installListeners()
          This method installs the listeners for the JInternalFrame.
protected  void installMouseHandlers(JComponent c)
          This method installs the necessary MouseListeners from the given JComponent.
 void installUI(JComponent c)
          This method installs a UI for the JInternalFrame.
 boolean isKeyBindingActive()
          DOCUMENT ME!
protected  boolean isKeyBindingRegistered()
          DOCUMENT ME!
protected  void maximizeFrame(JInternalFrame f)
          This is a convenience method that maximizes the JInternalFrame.
protected  void minimizeFrame(JInternalFrame f)
          This is a convenience method that minimizes the JInternalFrame.
protected  void replacePane(JComponent currentPane, JComponent newPane)
          This method replaces the currentPane with the newPane.
 void setEastPane(JComponent c)
          This method sets the east pane to be the given JComponent.
protected  void setKeyBindingActive(boolean b)
          DOCUMENT ME!
protected  void setKeyBindingRegistered(boolean b)
          DOCUMENT ME!
 void setNorthPane(JComponent c)
          This method sets the north pane to be the given JComponent.
 void setSouthPane(JComponent c)
          This method sets the south pane to be the given JComponent.
protected  void setupMenuCloseKey()
          DOCUMENT ME!
protected  void setupMenuOpenKey()
          DOCUMENT ME!
 void setWestPane(JComponent c)
          This method sets the west pane to be the given JComponent.
protected  void uninstallComponents()
          This method uninstalls the Components for the JInternalFrame.
protected  void uninstallDefaults()
          This method uninstalls the defaults for the JInternalFrame.
protected  void uninstallKeyboardActions()
          This method uninstalls the keyboard actions for the JInternalFrame.
protected  void uninstallListeners()
          This method uninstalls the listeners for the JInternalFrame.
 void uninstallUI(JComponent c)
          This method reverses the work done by installUI.
 
Methods inherited from class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, paint, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

borderListener

protected MouseInputAdapter borderListener
The MouseListener that is responsible for dragging and resizing the JInternalFrame in response to MouseEvents.


componentListener

protected ComponentListener componentListener
The ComponentListener that is responsible for resizing the JInternalFrame in response to ComponentEvents from the JDesktopPane.


glassPaneDispatcher

protected MouseInputListener glassPaneDispatcher
The MouseListener that is responsible for activating the JInternalFrame when the mouse press activates one of its descendents.


propertyChangeListener

protected PropertyChangeListener propertyChangeListener
The PropertyChangeListener that is responsible for listening to PropertyChangeEvents from the JInternalFrame.


eastPane

protected JComponent eastPane
The JComponent placed at the east region of the JInternalFrame.


northPane

protected JComponent northPane
The JComponent placed at the north region of the JInternalFrame.


southPane

protected JComponent southPane
The JComponent placed at the south region of the JInternalFrame.


westPane

protected JComponent westPane
The JComponent placed at the west region of the JInternalFrame.


openMenuKey

protected KeyStroke openMenuKey
Deprecated. 
The Keystroke bound to open the menu.


titlePane

protected BasicInternalFrameTitlePane titlePane
The TitlePane displayed at the top of the JInternalFrame.


frame

protected JInternalFrame frame
The JInternalFrame this UI is responsible for.


internalFrameLayout

protected LayoutManager internalFrameLayout
The LayoutManager used in the JInternalFrame.

Constructor Detail

BasicInternalFrameUI

public BasicInternalFrameUI(JInternalFrame b)
Creates a new BasicInternalFrameUI object.

Parameters:
b - The JInternalFrame this UI will represent.
Method Detail

createUI

public static ComponentUI createUI(JComponent b)
This method will create a new BasicInternalFrameUI for the given JComponent.

Parameters:
b - The JComponent to create a BasicInternalFrameUI for.
Returns:
A new BasicInternalFrameUI.

installUI

public void installUI(JComponent c)
This method installs a UI for the JInternalFrame.

Overrides:
installUI in class ComponentUI
Parameters:
c - The JComponent to install this UI on.
See Also:
ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

uninstallUI

public void uninstallUI(JComponent c)
This method reverses the work done by installUI.

Overrides:
uninstallUI in class ComponentUI
Parameters:
c - The JComponent to uninstall this UI for.
See Also:
ComponentUI.installUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

installDefaults

protected void installDefaults()
This method installs the defaults specified by the look and feel.


installKeyboardActions

protected void installKeyboardActions()
This method installs the keyboard actions for the JInternalFrame.


installComponents

protected void installComponents()
This method installs the Components for the JInternalFrame.


installListeners

protected void installListeners()
This method installs the listeners for the JInternalFrame.


uninstallDefaults

protected void uninstallDefaults()
This method uninstalls the defaults for the JInternalFrame.


uninstallComponents

protected void uninstallComponents()
This method uninstalls the Components for the JInternalFrame.


uninstallListeners

protected void uninstallListeners()
This method uninstalls the listeners for the JInternalFrame.


uninstallKeyboardActions

protected void uninstallKeyboardActions()
This method uninstalls the keyboard actions for the JInternalFrame.


createLayoutManager

protected LayoutManager createLayoutManager()
This method creates a new LayoutManager for the JInternalFrame.

Returns:
A new LayoutManager for the JInternalFrame.

createPropertyChangeListener

protected PropertyChangeListener createPropertyChangeListener()
This method creates a new PropertyChangeListener for the JInternalFrame.

Returns:
A new PropertyChangeListener for the JInternalFrame.

getPreferredSize

public Dimension getPreferredSize(JComponent x)
This method returns the preferred size of the given JComponent.

Overrides:
getPreferredSize in class ComponentUI
Parameters:
x - The JComponent to find a preferred size for.
Returns:
The preferred size.

getMinimumSize

public Dimension getMinimumSize(JComponent x)
This method returns the minimum size of the given JComponent.

Overrides:
getMinimumSize in class ComponentUI
Parameters:
x - The JComponent to find a minimum size for.
Returns:
The minimum size.

getMaximumSize

public Dimension getMaximumSize(JComponent x)
This method returns the maximum size of the given JComponent.

Overrides:
getMaximumSize in class ComponentUI
Parameters:
x - The JComponent to find a maximum size for.
Returns:
The maximum size.

replacePane

protected void replacePane(JComponent currentPane,
                           JComponent newPane)
This method replaces the currentPane with the newPane. When replacing it also removes the MouseHandlers for the old pane and installs them on the new pane.

Parameters:
currentPane - The old pane to remove.
newPane - The new pane to install.

deinstallMouseHandlers

protected void deinstallMouseHandlers(JComponent c)
This method removes the necessary MouseListeners from the given JComponent.

Parameters:
c - The JComponent to remove MouseListeners from.

installMouseHandlers

protected void installMouseHandlers(JComponent c)
This method installs the necessary MouseListeners from the given JComponent.

Parameters:
c - The JComponent to install MouseListeners on.

createNorthPane

protected JComponent createNorthPane(JInternalFrame w)
This method creates the north pane used in the JInternalFrame.

Parameters:
w - The JInternalFrame to create a north pane for.
Returns:
The north pane.

createWestPane

protected JComponent createWestPane(JInternalFrame w)
This method creates the west pane used in the JInternalFrame.

Parameters:
w - The JInternalFrame to create a west pane for.
Returns:
The west pane.

createSouthPane

protected JComponent createSouthPane(JInternalFrame w)
This method creates the south pane used in the JInternalFrame.

Parameters:
w - The JInternalFrame to create a south pane for.
Returns:
The south pane.

createEastPane

protected JComponent createEastPane(JInternalFrame w)
This method creates the east pane used in the JInternalFrame.

Parameters:
w - The JInternalFrame to create an east pane for.
Returns:
The east pane.

createBorderListener

protected MouseInputAdapter createBorderListener(JInternalFrame w)
This method returns a new BorderListener for the given JInternalFrame.

Parameters:
w - The JIntenalFrame to create a BorderListener for.
Returns:
A new BorderListener.

createInternalFrameListener

protected void createInternalFrameListener()
This method creates a new InternalFrameListener for the JInternalFrame.


isKeyBindingRegistered

protected final boolean isKeyBindingRegistered()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setKeyBindingRegistered

protected final void setKeyBindingRegistered(boolean b)
DOCUMENT ME!

Parameters:
b - DOCUMENT ME!

isKeyBindingActive

public final boolean isKeyBindingActive()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setKeyBindingActive

protected final void setKeyBindingActive(boolean b)
DOCUMENT ME!

Parameters:
b - DOCUMENT ME!

setupMenuOpenKey

protected void setupMenuOpenKey()
DOCUMENT ME!


setupMenuCloseKey

protected void setupMenuCloseKey()
DOCUMENT ME!


getNorthPane

public JComponent getNorthPane()
This method returns the north pane.

Returns:
The north pane.

setNorthPane

public void setNorthPane(JComponent c)
This method sets the north pane to be the given JComponent.

Parameters:
c - The new north pane.

getSouthPane

public JComponent getSouthPane()
This method returns the south pane.

Returns:
The south pane.

setSouthPane

public void setSouthPane(JComponent c)
This method sets the south pane to be the given JComponent.

Parameters:
c - The new south pane.

setEastPane

public void setEastPane(JComponent c)
This method sets the east pane to be the given JComponent.

Parameters:
c - The new east pane.

getEastPane

public JComponent getEastPane()
This method returns the east pane.

Returns:
The east pane.

setWestPane

public void setWestPane(JComponent c)
This method sets the west pane to be the given JComponent.

Parameters:
c - The new west pane.

getWestPane

public JComponent getWestPane()
This method returns the west pane.

Returns:
The west pane.

getDesktopManager

protected DesktopManager getDesktopManager()
This method returns the DesktopManager to use with the JInternalFrame.

Returns:
The DesktopManager to use with the JInternalFrame.

createDesktopManager

protected DesktopManager createDesktopManager()
This method returns a default DesktopManager that can be used with this JInternalFrame.

Returns:
A default DesktopManager that can be used with this JInternalFrame.

closeFrame

protected void closeFrame(JInternalFrame f)
This is a convenience method that closes the JInternalFrame.

Parameters:
f - The JInternalFrame to close.

maximizeFrame

protected void maximizeFrame(JInternalFrame f)
This is a convenience method that maximizes the JInternalFrame.

Parameters:
f - The JInternalFrame to maximize.

minimizeFrame

protected void minimizeFrame(JInternalFrame f)
This is a convenience method that minimizes the JInternalFrame.

Parameters:
f - The JInternalFrame to minimize.

iconifyFrame

protected void iconifyFrame(JInternalFrame f)
This is a convenience method that iconifies the JInternalFrame.

Parameters:
f - The JInternalFrame to iconify.

deiconifyFrame

protected void deiconifyFrame(JInternalFrame f)
This is a convenience method that deiconifies the JInternalFrame.

Parameters:
f - The JInternalFrame to deiconify.

activateFrame

protected void activateFrame(JInternalFrame f)
This is a convenience method that activates the JInternalFrame.

Parameters:
f - The JInternalFrame to activate.

deactivateFrame

protected void deactivateFrame(JInternalFrame f)
This is a convenience method that deactivates the JInternalFrame.

Parameters:
f - the JInternalFrame to deactivate

createComponentListener

protected ComponentListener createComponentListener()
This method returns a new ComponentListener for the JDesktopPane.

Returns:
A new ComponentListener.

createGlassPaneDispatcher

protected MouseInputListener createGlassPaneDispatcher()
This method returns a new GlassPaneDispatcher.

Returns:
A new GlassPaneDispatcher.