org.gvsig.coreplugin.mdiManager

Class NewSkin

java.lang.Object

org.gvsig.andami.plugins.Extension

org.gvsig.coreplugin.mdiManager.NewSkin

All Implemented Interfaces:

IExtension, IExtensionExecuteWithArgs, IExtensionQueryByAction, MDIManager

public class NewSkin
extends Extension
implements MDIManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NewSkin.DialogWindowListener Listener para los eventos de cerrado de los dialogos.
class	NewSkin.FrameListener

Field Summary

Fields inherited from interface org.gvsig.andami.ui.mdiManager.MDIManager

ALIGN_CENTER, ALIGN_FIRST_LINE_END, ALIGN_FIRST_LINE_END_CASCADE, ALIGN_FIRST_LINE_START, ALIGN_LAST_LINE_END, ALIGN_LAST_LINE_START, ALIGN_LINE_END, ALIGN_LINE_START, ALIGN_PAGE_END, ALIGN_PAGE_START, DIALOG, TOOL, WINDOW

Constructor Summary

Constructors

Constructor and Description
NewSkin()

Method Summary

Modifier and Type	Method and Description
IWindow	addCentredWindow(IWindow p) Creates a new frame with the provided contents, and shows this new window.
IWindow	addWindow(IWindow p) Creates a new frame with the provided contents, and shows this new window.
IWindow	addWindow(IWindow p, int align)
void	alignFrame(IWindow panel, int mode)
void	centreFrame(IWindow panel) Centres the Frame in the contentPane of the MainFrame.
void	changeWindowInfo(IWindow w, WindowInfo wi) Updates the window properties (size, location, etc) according to the provided WindowInfo object.
void	closeAllWindows() Close all the currently open windows
boolean	closeSingletonWindow(java.lang.Class viewClass, java.lang.Object model) Close the SingletonWindow whose class and model are provided as parameters.
boolean	closeSingletonWindow(java.lang.Object model) Close the SingletonWindow whose model is provided as parameter.
void	closeWindow(IWindow p) Close the provided window.
protected FrameWindowSupport	createFrameWindowSupport(MDIFrame mainFrame) Create the FrameWindowSupport instance
void	execute(java.lang.String actionCommand) This method is executed when the user clicks on any of the controls associated with this extension (menus, tools, etc).
IWindow	getActiveWindow() Returns the currently active window, excluding the modal windows and the PALETTE windows.
IWindow[]	getAllWindows() Gets all the open windows.
javax.swing.JDesktopPane	getDesktopPane()
IWindow	getFocusWindow() Returns the currently focused window, excluding the modal windows.
java.awt.image.BufferedImage	getImagePreview()
java.awt.Dimension	getInternalSize()
IWindow[]	getOrderedWindows() Gets all the open windows (as MDIManager.getAllWindows()), but in this method the windows are returned in the same deepness order that they have in the application.
SingletonWindow	getSingletonWindow(java.lang.Class windowClass, java.lang.Object model) Return the window associated to the SingletonWindow class and the model specified.
IWindow	getWindow(javax.swing.JPanel panel) Gets the associated IWindow to the panel shown with showWindow method.
WindowInfo	getWindowInfo(IWindow w) Gets the WindowInfo object associated with the provided window.
void	init(MDIFrame f) Initializes the MDIFrame.
void	initialize() Extension's initialization code should be here.
boolean	isEnabled() This method is invoked by Andami to check whether the extension (and its associated controls) is enabled or disabled.
boolean	isModalDialogShowing()
boolean	isVisible() This method is invoked by Andami to check whether the extension (and its associated controls) is visible or hidden.
void	move(IWindow panel, int x, int y) Change the position of the speficied window.
void	moveToFrom(IWindow win)
void	refresh(IWindow win) Forces a window to be repainted.
void	restoreCursor() Sets the normal cursor and unblocks events from main window.
void	setBackgroundImage(javax.swing.ImageIcon image, java.lang.String typeDesktop) Sets the provided image as background image in the main window.
void	setLocale(java.util.Locale locale)
void	setMaximum(IWindow v, boolean bMaximum) Maximizes or restores the provided window
void	setWaitCursor() Shows the wait cursor and blocks all the events from main window until MDIManager.restoreCursor() is called.
void	showWindow(javax.swing.JPanel panel, java.lang.String title, WindowManager.MODE mode) Useful method to simplify the presentation of a window.

Methods inherited from class org.gvsig.andami.plugins.Extension

canQueryByAction, execute, getPlugin, getStatus, getStatus, getText, isEnabled, isVisible, postInitialize, setPlugin, terminate

Methods inherited from class java.lang.Object

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

Constructor Detail

NewSkin

public NewSkin()

Method Detail

getDesktopPane

public javax.swing.JDesktopPane getDesktopPane()

getImagePreview

public java.awt.image.BufferedImage getImagePreview()

Specified by:

getImagePreview in interface MDIManager

init

public void init(MDIFrame f)

Description copied from interface: MDIManager

Initializes the MDIFrame. It must be called before starting to use it. It receives the application's main frame (MDIFrame) as parameter.

Specified by:

init in interface MDIManager

Parameters:

f - Application's main frame.

createFrameWindowSupport

protected FrameWindowSupport createFrameWindowSupport(MDIFrame mainFrame)

Create the FrameWindowSupport instance

Parameters:

mainFrame -

Returns:

addWindow

public IWindow addWindow(IWindow p)
                  throws SingletonDialogAlreadyShownException

Description copied from interface: MDIManager

Creates a new frame with the provided contents, and shows this new window. The new frame's properties are set according to the WindowInfo object from IWindow's getWindowInfo() method. The new frame is disposed when closed.

If the provided IWindow also implements SingletonWindow, and another SingletonWindow already exists and uses the same model, this later window will be sent to the foreground and no new window will be created.

Specified by:

addWindow in interface MDIManager

Parameters:

p - Panel with the contents of the new window.

Returns:

Returns the added IWindow, or in case it is a SingletonWindow and there is another SingletonWindow with the same model that it is already shown, returns this later SingletonWindow.

Throws:

SingletonDialogAlreadyShownException

getSingletonWindow

public SingletonWindow getSingletonWindow(java.lang.Class windowClass,
                                          java.lang.Object model)

Description copied from interface: MDIManager

Return the window associated to the SingletonWindow class and the model specified. If not exists any singleton window associated to this null is returned.

Specified by:

getSingletonWindow in interface MDIManager

Returns:

the requested window or null.

addCentredWindow

public IWindow addCentredWindow(IWindow p)
                         throws SingletonDialogAlreadyShownException

Description copied from interface: MDIManager

Creates a new frame with the provided contents, and shows this new window. The new frame will be centered, regardless the position specified in the WindowInfo object from IWindow's getWindowInfo() method. The new frame is disposed when closed.

If the provided IWindow also implements SingletonWindow, and another SingletonWindow already exists and uses the same model, this later window will be sent to the foreground and no new window will be created.

Specified by:

addCentredWindow in interface MDIManager

Parameters:

p - Panel with the contents of the new window.

Returns:

Returns the added IWindow, or in case it is a SingletonWindow and there is another SingletonWindow with the same model that it is already shown, returns this later SingletonWindow.

Throws:

SingletonDialogAlreadyShownException

addWindow

public IWindow addWindow(IWindow p,
                         int align)
                  throws SingletonDialogAlreadyShownException

Specified by:

addWindow in interface MDIManager

Throws:

SingletonDialogAlreadyShownException

move

public void move(IWindow panel,
                 int x,
                 int y)

Description copied from interface: MDIManager

Change the position of the speficied window.

Specified by:

move in interface MDIManager

centreFrame

public void centreFrame(IWindow panel)

Centres the Frame in the contentPane of the MainFrame. If the frame can't be showed completely, it tries to show its top-left corner.

Parameters:

panel - The IWindow to centre

getInternalSize

public java.awt.Dimension getInternalSize()

Specified by:

getInternalSize in interface MDIManager

alignFrame

public void alignFrame(IWindow panel,
                       int mode)

moveToFrom

public void moveToFrom(IWindow win)

Specified by:

moveToFrom in interface MDIManager

getActiveWindow

public IWindow getActiveWindow()

Description copied from interface: MDIManager

Returns the currently active window, excluding the modal windows and the PALETTE windows. If the currently active window is modal or PALETTE type, the previous non-modal and non-PALETTE active window is returned.

Modal windows and PALETTE windows are considered to be auxiliary windows, that is the reason why they are not returned.

Specified by:

getActiveWindow in interface MDIManager

Returns:

A reference to the active window, or null if there is no active window

getFocusWindow

public IWindow getFocusWindow()

Description copied from interface: MDIManager

Returns the currently focused window, excluding the modal windows. If the currently focused window is modal, the previous non-modal focused window is returned.

Specified by:

getFocusWindow in interface MDIManager

Returns:

A reference to the focused window, or null if there is no focused window

closeWindow

public void closeWindow(IWindow p)

Description copied from interface: MDIManager

Close the provided window. If the window is openend with the WindowManager, use setVisible(false) in the JPanel to close it.

Specified by:

closeWindow in interface MDIManager

Parameters:

p - window to be closed

closeAllWindows

public void closeAllWindows()

Description copied from interface: MDIManager

Close all the currently open windows

Specified by:

closeAllWindows in interface MDIManager

getWindowInfo

public WindowInfo getWindowInfo(IWindow w)

Description copied from interface: MDIManager

Gets the WindowInfo object associated with the provided window.

Specified by:

getWindowInfo in interface MDIManager

Parameters:

w - window whose information is to be retrieved

Returns:

WindowInfo The WindowInfo object containing the information about the provided window

See Also:

WindowInfo

initialize

public void initialize()

Description copied from interface: IExtension

Extension's initialization code should be here. This method is called for all the extensions during Andami's initialization.

Specified by:

initialize in interface IExtension

execute

public void execute(java.lang.String actionCommand)

Description copied from interface: IExtension

This method is executed when the user clicks on any of the controls associated with this extension (menus, tools, etc).

Specified by:

execute in interface IExtension

Parameters:

actionCommand - An String specifying the action to execute. This is useful when there are different controls associated with the same extension.

isEnabled

public boolean isEnabled()

Description copied from interface: IExtension

This method is invoked by Andami to check whether the extension (and its associated controls) is enabled or disabled. Disabled controls (menus and buttons) are shown in light grey colour, and it is not possible to click on them.

Specified by:

isEnabled in interface IExtension

Returns:

true if the extension should be enabled, false otherwise

isVisible

public boolean isVisible()

Description copied from interface: IExtension

This method is invoked by Andami to check whether the extension (and its associated controls) is visible or hidden.

Specified by:

isVisible in interface IExtension

Returns:

true if the extension should be visible, false otherwise

setWaitCursor

public void setWaitCursor()

Description copied from interface: MDIManager

Shows the wait cursor and blocks all the events from main window until MDIManager.restoreCursor() is called.

Specified by:

setWaitCursor in interface MDIManager

restoreCursor

public void restoreCursor()

Description copied from interface: MDIManager

Sets the normal cursor and unblocks events from main window.

Specified by:

restoreCursor in interface MDIManager

See Also:

MDIManager.setWaitCursor()

closeSingletonWindow

public boolean closeSingletonWindow(java.lang.Class viewClass,
                                    java.lang.Object model)

Description copied from interface: MDIManager

Close the SingletonWindow whose class and model are provided as parameters.

Specified by:

closeSingletonWindow in interface MDIManager

Parameters:

viewClass - Class of the window which is to be closed

model - Model of the window which is to be closed

Returns:

true if there is an open window whose class and model match the provided parameteres, false otherwise.

closeSingletonWindow

public boolean closeSingletonWindow(java.lang.Object model)

Description copied from interface: MDIManager

Close the SingletonWindow whose model is provided as parameter.

Specified by:

closeSingletonWindow in interface MDIManager

Parameters:

model - Model of the window which is to be closed

Returns:

true if there is an open window whose model matchs the provided one, false otherwise.

getAllWindows

public IWindow[] getAllWindows()

Description copied from interface: MDIManager

Gets all the open windows. Minimized and maximized windows are included. The application's main frame is excluded; it can be accessed using PluginServices.getMainFrame().

Specified by:

getAllWindows in interface MDIManager

Returns:

An IWindow array containing all the open windows.

getOrderedWindows

public IWindow[] getOrderedWindows()

Description copied from interface: MDIManager

Gets all the open windows (as MDIManager.getAllWindows()), but in this method the windows are returned in the same deepness order that they have in the application.

Specified by:

getOrderedWindows in interface MDIManager

Returns:

An ordered array containing all the panels in the application. The first element of the array is the topmost (foreground) window in the application. The last element is the bottom (background) window.

setMaximum

public void setMaximum(IWindow v,
                       boolean bMaximum)
                throws java.beans.PropertyVetoException

Description copied from interface: MDIManager

Maximizes or restores the provided window

Specified by:

setMaximum in interface MDIManager

Parameters:

v - The window to be maximized or restored

bMaximum - If true, the window will be maximized, if false, it will be restored

Throws:

java.beans.PropertyVetoException

changeWindowInfo

public void changeWindowInfo(IWindow w,
                             WindowInfo wi)

Description copied from interface: MDIManager

Updates the window properties (size, location, etc) according to the provided WindowInfo object.

Specified by:

changeWindowInfo in interface MDIManager

Parameters:

w - The window whose properties are to be changed

wi - The WindowInfo object containing the new properties to be set

refresh

public void refresh(IWindow win)

Description copied from interface: MDIManager

Forces a window to be repainted. Normally, this is not necessary, as windows are refreshed when necessary.

Specified by:

refresh in interface MDIManager

Parameters:

win - The window to be refreshed.

setBackgroundImage

public void setBackgroundImage(javax.swing.ImageIcon image,
                               java.lang.String typeDesktop)

Description copied from interface: MDIManager

Sets the provided image as background image in the main window. The image will be centered, set in mosaic or expanded to fill the full window, depending on the typeDesktop argument.

Specified by:

setBackgroundImage in interface MDIManager

Parameters:

image - The image to be set as background image

typeDesktop - Decides whether the image should be centered, set in mosaic or expanded. Accepted values are: Theme.CENTERED, Theme.MOSAIC and Theme.EXPAND.

showWindow

public void showWindow(javax.swing.JPanel panel,
                       java.lang.String title,
                       WindowManager.MODE mode)

Description copied from interface: MDIManager

Useful method to simplify the presentation of a window. For more precise control over the behavior of the window use addWindow This methos

Specified by:

showWindow in interface MDIManager

Parameters:

panel - to show as a window

title - title of the window

mode - type of the window to create

getWindow

public IWindow getWindow(javax.swing.JPanel panel)

Description copied from interface: MDIManager

Gets the associated IWindow to the panel shown with showWindow method. Also panel shown with the tools WindowManager.

Specified by:

getWindow in interface MDIManager

Returns:

setLocale

public void setLocale(java.util.Locale locale)

Specified by:

setLocale in interface MDIManager

isModalDialogShowing

public boolean isModalDialogShowing()

Specified by:

isModalDialogShowing in interface MDIManager