SwingFrameLayoutController (Tensegrity API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.tensegrity.skeleton.swing
Class SwingFrameLayoutController

java.lang.Object
  com.tensegrity.skeleton.swing.SwingFrameLayoutController

public class SwingFrameLayoutController
extends java.lang.Object

The SwingFrameLayoutController gathers all the logic behind the ApplicationFrame layout of toolboxes and graphDocuments. Methods within this class ensure that the global layout of the application and the application itself (i.e. menu and toolbars) are kept in a valid state when the ToggleLeftColumnCommand,ToggleRightColumnCommand commands, and the menu items used in order to hide or show toolboxes are used. Note that this controller also manages the application state when the user closes the toolboxes using the top-right cross on their respective panels. It is recommanded to subclass this class in order to provide application specific initial containers size values as well as specific resize weights for the application's JSplitPanes. In order to do so the following methods are provided:

Please refer to these methods documentation for more information. It is also important to note that each container is initialized with a default minimum size (DEFAULT_MINIMUM_SIZE). However, subclasses can override these values by means of the setupContainersMinimumSizes() method. It is also recommended to go through the JSplitPane's class documentation for a better understanding of the resize weights.

Version:: $Id: SwingFrameLayoutController.java,v 1.56 2005/08/16 10:20:22 BurkhardWick Exp $
Author:: S�bastien Guyon

Field Summary
`static java.awt.Dimension`	`DEFAULT_MINIMUM_SIZE` This is the default minimum size for each container.
`static int`	`SLIDE_PANEL_EAST` Public constants for layout positions/constraints.
`static int`	`SLIDE_PANEL_NORTH_EAST` Public constants for layout positions/constraints.
`static int`	`SLIDE_PANEL_NORTH_WEST` Public constants for layout positions/constraints.
`static int`	`SLIDE_PANEL_SOUTH` Public constants for layout positions/constraints.
`static int`	`SLIDE_PANEL_SOUTH_EAST` Public constants for layout positions/constraints.
`static int`	`SLIDE_PANEL_SOUTH_WEST` Public constants for layout positions/constraints.
`static int`	`SLIDE_PANEL_WEST` Public constants for layout positions/constraints.
`static double`	`SPLITPANE_DEFAULT_RESIZE_WEIGHT` Constant defining the default resize weight for split panes
`static java.lang.String`	`SPLITPANE_HORIZONTAL_BOTTOM_LEFT` Constant to be used by subclasses in `setupSplitPanesResizeWeights()`.
`static java.lang.String`	`SPLITPANE_HORIZONTAL_BOTTOM_RIGHT` Constant to be used by subclasses in `setupSplitPanesResizeWeights()`.
`static java.lang.String`	`SPLITPANE_HORIZONTAL_MIDDLE` Constant to be used by subclasses in `setupSplitPanesResizeWeights()`.
`static java.lang.String`	`SPLITPANE_HORIZONTAL_TOP_LEFT` Constant to be used by subclasses in `setupSplitPanesResizeWeights()`.
`static java.lang.String`	`SPLITPANE_HORIZONTAL_TOP_RIGHT` Constant to be used by subclasses in `setupSplitPanesResizeWeights()`.
`static java.lang.String`	`SPLITPANE_VERTICAL_LEFT` Constant to be used by subclasses in `setupSplitPanesResizeWeights()`.
`static java.lang.String`	`SPLITPANE_VERTICAL_RIGHT` Constant to be used by subclasses in `setupSplitPanesResizeWeights()`.

Constructor Summary
`SwingFrameLayoutController(SwingApplicationFrame applicationFrame)` Creates a new `SwingFrameLayoutController`.

Method Summary
`protected SwingApplicationFrame`	`getApplicationFrame()` Returns the local `SwingApplicationFrame` instance.
`protected int`	`getDefaultDividerSize()` Returns the split panes divider sizes depending on the current L&F.
`protected Container`	`getEastContainer()` Returns the application specific East Container
`FrameLayoutSnapshot`	`getFameLayoutSnapshot()` This method returns an instance of `FrameLayoutSnapshot` which contains all the information required in order to re-build the application frame layout the next time the application is started.
`protected Container`	`getNorthEastContainer()` Returns the application specific North East Container
`protected Container`	`getNorthWestContainer()` Returns the application specific North West Container
`protected Container`	`getSouthContainer()` Returns the application specific South Container
`protected Container`	`getSouthEastContainer()` Returns the application specific South East Container
`protected Container`	`getSouthWestContainer()` Returns the application specific South West Container
`protected Container`	`getWestContainer()` Returns the application specific West Container
`boolean`	`isLeftColumnVisible()` Returns true if the left column is visible, false otherwise
`boolean`	`isRightColumnVisible()` Returns true if the right column is visible, false otherwise
`void`	`restorePreferencesFrameLayout(FrameLayoutSnapshot snapshot)` This method sets up this `SwingFrameLayoutController` instance in such a way that the application frame will be layouted with all the information contained into the passed `FrameLayoutSnapshot`.
`protected void`	`setDefaultEastContainer(Container defaultEastContainer)` Use this method in order to set the `Container` which should act as a default container for the right column.
`protected void`	`setDefaultWestContainer(Container defaultWestContainer)` Use this method in order to set the `Container` which should act as a default container for the left column.
`protected void`	`setupContainerInitialSize(Container container, java.awt.Dimension size)` Method used in order to set a container's initial size.
`protected void`	`setupContainerMinimumSize(Container container, java.awt.Dimension size)` Method used in order to set a container's initial size.
`protected void`	`setupContainersInitialSizes()` Method used in order to set containers initial sizes.
`protected void`	`setupContainersMinimumSizes()` Method used in order to set containers minimum sizes.
`protected java.util.HashMap`	`setupSplitPanesResizeWeights()` Method used in order to set up `JSplitPane` s resize weights.
`protected void`	`showColumnSlidePanel(Container slidePanel, boolean isLeftColumn)` Shows or hide the passed container depending on its current state.
`boolean`	`showSlidePanel(Container containerInstance)` This method can be used in order to show or hide the passed `Container`, depending on its visible state.
`void`	`showSlidePanel(int slidePanelIndex)` This method can be used in order to show or hide the `Container` corresponding to the passed `slidePanelIndex`, depending on its visible state.
`protected void`	`showSouthSlidePanel(Container slidePanel)` Shows or hides the south container.
`void`	`toggleLeftColumn()` Method called by the perform method of ToggleLeftColumnCommand
`void`	`toggleRightColumn()` Method called by the perform method of ToggleLeftColumnCommand

Methods inherited from class java.lang.Object

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

Field Detail