net.infonode.docking.util
Class DeveloperUtil

java.lang.Object
  extended by net.infonode.docking.util.DeveloperUtil

public class DeveloperUtil
extends java.lang.Object

Utility methods to make certain tasks easier during the development of an application using IDW.

Note: These methods might be changed/removed or not be compatible with future versions of IDW.

Since:
IDW 1.4.0
Version:
$Revision: 1.9 $
Author:
$Author: jesper $

Field Summary
private static java.lang.String INDENT_STRING
           
 
Constructor Summary
DeveloperUtil()
           
 
Method Summary
static javax.swing.JFrame createWindowLayoutFrame(java.lang.String title, DockingWindow window)
           Creates a JFrame with a text area that shows the layout of the given window as pseudo-like Java code, i.e. the layout retrieved by getWindowLayoutAsString(DockingWindow).
private static java.lang.String getDockingWindowLayout(DockingWindow window, int depth)
           
private static java.lang.String getRootWindowLayout(RootWindow window, int depth)
           
private static java.lang.String getSplitWindowLayout(SplitWindow window, int depth)
           
private static java.lang.String getTabWindowLayout(TabWindow window, int depth)
           
private static java.lang.String getViewLayout(View view, int depth)
           
static java.lang.String getWindowLayoutAsString(DockingWindow window)
           Returns a Java code pseudo-like string with information about the current window layout in a docking window.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INDENT_STRING

private static java.lang.String INDENT_STRING
Constructor Detail

DeveloperUtil

public DeveloperUtil()
Method Detail

getWindowLayoutAsString

public static java.lang.String getWindowLayoutAsString(DockingWindow window)

Returns a Java code pseudo-like string with information about the current window layout in a docking window.

If the given window is a root window a complete layout is returned i.e. windows inside the root window, windows on window bars and floating windows. This is useful when for example creating a default layout. Just add all the views to the root window, drag them around to create a nice layout and the call this function to retrieve the layout as a string.

Note: The returned string contains pseudo-like Java code. All views in the layout are called View: "title" - view class.

Note: The method might be changed/removed or not be compatible with future versions of IDW.

Parameters:
window - the docking window to retrieve layout for
Returns:
the layout as a pseudo-like Java code

createWindowLayoutFrame

public static javax.swing.JFrame createWindowLayoutFrame(java.lang.String title,
                                                         DockingWindow window)

Creates a JFrame with a text area that shows the layout of the given window as pseudo-like Java code, i.e. the layout retrieved by getWindowLayoutAsString(DockingWindow). The frame also has a button that when clicked gets the current layout from the window.

The frame is useful when designing window layouts in an application. Just create a frame and use your root window as window. Drag around your views, press the "Get Layout" button and you'll se your layout in the text area.

Note: The method might be changed/removed or not be compatible with future versions of IDW.

Parameters:
title - frame title
window - the docking window to retrieve layout for
Returns:
the frame

getDockingWindowLayout

private static java.lang.String getDockingWindowLayout(DockingWindow window,
                                                       int depth)

getRootWindowLayout

private static java.lang.String getRootWindowLayout(RootWindow window,
                                                    int depth)

getTabWindowLayout

private static java.lang.String getTabWindowLayout(TabWindow window,
                                                   int depth)

getSplitWindowLayout

private static java.lang.String getSplitWindowLayout(SplitWindow window,
                                                     int depth)

getViewLayout

private static java.lang.String getViewLayout(View view,
                                              int depth)