ucar.unidata.ui

Class MultiFrame

java.lang.Object

ucar.unidata.ui.MultiFrame

Direct Known Subclasses:

IdvWindow

public class MultiFrame
extends java.lang.Object

A class that holds either a JFrame or a JInteralFrame. It allows for client code to eqaily switch between regular windows and JDesktop windows

Author:

IDV development team

Constructor Summary

Constructors

Constructor and Description
MultiFrame() ctor
MultiFrame(javax.swing.JFrame frame) ctor
MultiFrame(javax.swing.JInternalFrame internalFrame) ctor
MultiFrame(java.lang.String title) ctor

Method Summary

Modifier and Type	Method and Description
void	addWindowListener(java.awt.event.WindowListener l) wrapper method
void	dispose() dispose of the component
java.awt.Rectangle	getBounds() wrapper method
java.awt.Component	getComponent() Return the component.
java.awt.Container	getContainer() Get the container
java.awt.Container	getContentPane() Get the content pane of the component
javax.swing.JFrame	getFrame() access the JFrame
javax.swing.JInternalFrame	getInternalFrame() Access the internal frame
java.awt.Point	getLocation() wrapper method
java.awt.Dimension	getSize() wrapper method
int	getState() wrapper method
java.lang.String	getTitle() Get the title
java.awt.Window	getWindow() Finds the Window we are a part of
boolean	isShowing() wrapper method
boolean	isVisible() wrapper method
void	pack() wrapper method
void	removeWindowListener(java.awt.event.WindowListener l) wrapper method
void	setBounds(java.awt.Rectangle bounds) wrapper method
void	setCursor(java.awt.Cursor cursor) Set the cursor
void	setDefaultCloseOperation(int operation) wrapper method
void	setIconImage(java.awt.Image icon) wrapper method
void	setJMenuBar(javax.swing.JMenuBar menuBar) wrapper method
void	setLocation(int x, int y) wrapper method
void	setSize(java.awt.Dimension size) wrapper method
void	setState(int state) wrapper method
void	setTitle(java.lang.String title) Set the title
void	setVisible(boolean visible) set visibility of the component
void	show() Show the component
void	toFront() wrapper method
static void	useDesktopPane(javax.swing.JDesktopPane desktopPane) Set the global desktopPane.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiFrame

public MultiFrame()

ctor

MultiFrame

public MultiFrame(java.lang.String title)

ctor

Parameters:

title - Create a JFrame with the given title

MultiFrame

public MultiFrame(javax.swing.JFrame frame)

ctor

Parameters:

frame - The frame

MultiFrame

public MultiFrame(javax.swing.JInternalFrame internalFrame)

ctor

Parameters:

internalFrame - The internal frame

Method Detail

useDesktopPane

public static void useDesktopPane(javax.swing.JDesktopPane desktopPane)

Set the global desktopPane. This causes all default MultiFrames to be an internalFrame.

Parameters:

desktopPane - desktop pane

show

public void show()

Show the component

dispose

public void dispose()

dispose of the component

setVisible

public void setVisible(boolean visible)

set visibility of the component

Parameters:

visible - visible

getContentPane

public java.awt.Container getContentPane()

Get the content pane of the component

Returns:

content pane

getContainer

public java.awt.Container getContainer()

Get the container

Returns:

Either the frame or the internalFrame

setCursor

public void setCursor(java.awt.Cursor cursor)

Set the cursor

Parameters:

cursor - cursor

setState

public void setState(int state)

wrapper method

Parameters:

state - state

setTitle

public void setTitle(java.lang.String title)

Set the title

Parameters:

title - The title

getTitle

public java.lang.String getTitle()

Get the title

Returns:

The title

getFrame

public javax.swing.JFrame getFrame()

access the JFrame

Returns:

The frame

getInternalFrame

public javax.swing.JInternalFrame getInternalFrame()

Access the internal frame

Returns:

internal frame

getWindow

public java.awt.Window getWindow()

Finds the Window we are a part of

Returns:

the window

pack

public void pack()

wrapper method

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)

wrapper method

Parameters:

operation - operation

addWindowListener

public void addWindowListener(java.awt.event.WindowListener l)

wrapper method

Parameters:

l - listener

removeWindowListener

public void removeWindowListener(java.awt.event.WindowListener l)

wrapper method

Parameters:

l - _more_

setJMenuBar

public void setJMenuBar(javax.swing.JMenuBar menuBar)

wrapper method

Parameters:

menuBar - _more_

getBounds

public java.awt.Rectangle getBounds()

wrapper method

Returns:

_more_

setBounds

public void setBounds(java.awt.Rectangle bounds)

wrapper method

Parameters:

bounds - _more_

setIconImage

public void setIconImage(java.awt.Image icon)

wrapper method

Parameters:

icon - _more_

toFront

public void toFront()

wrapper method

getComponent

public java.awt.Component getComponent()

Return the component. Either the frame or the internalFrame

Returns:

The component

isVisible

public boolean isVisible()

wrapper method

Returns:

is visible

isShowing

public boolean isShowing()

wrapper method

Returns:

is showing

getLocation

public java.awt.Point getLocation()

wrapper method

Returns:

location

setLocation

public void setLocation(int x,
                        int y)

wrapper method

Parameters:

x - x

y - y

setSize

public void setSize(java.awt.Dimension size)

wrapper method

Parameters:

size - size_

getSize

public java.awt.Dimension getSize()

wrapper method

Returns:

size

getState

public int getState()

wrapper method

Returns:

state