org.pentaho.di.ui.core

Class ConstUI

java.lang.Object

org.pentaho.di.ui.core.ConstUI

public class ConstUI
extends Object

This class is used to define a number of default values for various settings throughout Kettle. It also contains a number of static final methods to make your life easier.

Since:

07-05-2003

Author:

Matt

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHECKBOX_WIDTH Default checkbox width
static int	COLOR_BACKGROUND_BLUE The default blue-component of the background color
static int	COLOR_BACKGROUND_GREEN The default green-component of the background color
static int	COLOR_BACKGROUND_RED The default red-component of the background color
static int	COLOR_GRAPH_BLUE The default blue-component of the graph background color
static int	COLOR_GRAPH_GREEN The default green-component of the graph background color
static int	COLOR_GRAPH_RED The default red-component of the graph background color
static int	COLOR_TAB_BLUE The default blue-component of the tab selected color
static int	COLOR_TAB_GREEN The default green-component of the tab selected color
static int	COLOR_TAB_RED The default red-component of the tab selected color
static int	DOCUMENTATION_ICON_SIZE
static int	GRID_SIZE Default grid size to which the graphical views snap.
static int	ICON_SIZE Default icon size
static int	INTERVAL_MS_TRANS_CANVAS_REFRESH the default canvas refresh interval for running transformations
static int	LARGE_ICON_SIZE
static int	LINE_WIDTH Default line width for arrows & around icons
static int	MEDIUM_ICON_SIZE
static int	MEDUIM_MARGIN margin between points of controls
static int	NOTE_MIN_SIZE The minimal size of a note on a graphical view (width & height)
static int	SMALL_ICON_SIZE
static int	SMALL_MARGIN margin between points of controls
static int	TOOLTIP_OFFSET Offset between pointer and tooltip position.

Constructor Summary

Constructors

Constructor and Description
ConstUI()

Method Summary

Modifier and Type	Method and Description
static void	displayMenu(org.eclipse.swt.widgets.Menu menu, org.eclipse.swt.widgets.Control control)
static void	displayMenu(org.pentaho.ui.xul.containers.XulMenupopup xulMenuPopup, org.eclipse.swt.widgets.Control control)
static org.eclipse.swt.widgets.TreeItem	findTreeItem(org.eclipse.swt.widgets.TreeItem parent, String name)
static org.eclipse.swt.widgets.TreeItem	findTreeItem(org.eclipse.swt.widgets.TreeItem parent, String parentName, String name) Finds a TreeItem with a certain label (name) in a (part of a) tree.
static void	flipExpanded(org.eclipse.swt.widgets.TreeItem ti) Flips the TreeItem from expanded to not expanded or vice-versa.
static int	getTreeLevel(org.eclipse.swt.widgets.TreeItem ti) Determine the level of where the TreeItem is position in a tree.
static String	getTreePath(org.eclipse.swt.widgets.TreeItem ti, int from) Return the tree path seperated by Const.FILE_SEPARATOR, starting from a certain depth in the tree.
static String[]	getTreeStrings(org.eclipse.swt.widgets.TreeItem ti) Get an array of strings containing the path from the given TreeItem to the parent.

Methods inherited from class java.lang.Object

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

Field Detail

ICON_SIZE

public static final int ICON_SIZE

Default icon size

See Also:

Constant Field Values

LARGE_ICON_SIZE

public static final int LARGE_ICON_SIZE

See Also:

Constant Field Values

SMALL_ICON_SIZE

public static final int SMALL_ICON_SIZE

See Also:

Constant Field Values

MEDIUM_ICON_SIZE

public static final int MEDIUM_ICON_SIZE

See Also:

Constant Field Values

DOCUMENTATION_ICON_SIZE

public static final int DOCUMENTATION_ICON_SIZE

See Also:

Constant Field Values

CHECKBOX_WIDTH

public static final int CHECKBOX_WIDTH

Default checkbox width

See Also:

Constant Field Values

LINE_WIDTH

public static final int LINE_WIDTH

Default line width for arrows & around icons

See Also:

Constant Field Values

GRID_SIZE

public static final int GRID_SIZE

Default grid size to which the graphical views snap.

See Also:

Constant Field Values

NOTE_MIN_SIZE

public static final int NOTE_MIN_SIZE

The minimal size of a note on a graphical view (width & height)

See Also:

Constant Field Values

TOOLTIP_OFFSET

public static final int TOOLTIP_OFFSET

Offset between pointer and tooltip position.

See Also:

Constant Field Values

COLOR_BACKGROUND_RED

public static final int COLOR_BACKGROUND_RED

The default red-component of the background color

See Also:

Constant Field Values

COLOR_BACKGROUND_GREEN

public static final int COLOR_BACKGROUND_GREEN

The default green-component of the background color

See Also:

Constant Field Values

COLOR_BACKGROUND_BLUE

public static final int COLOR_BACKGROUND_BLUE

The default blue-component of the background color

See Also:

Constant Field Values

COLOR_GRAPH_RED

public static final int COLOR_GRAPH_RED

The default red-component of the graph background color

See Also:

Constant Field Values

COLOR_GRAPH_GREEN

public static final int COLOR_GRAPH_GREEN

The default green-component of the graph background color

See Also:

Constant Field Values

COLOR_GRAPH_BLUE

public static final int COLOR_GRAPH_BLUE

The default blue-component of the graph background color

See Also:

Constant Field Values

COLOR_TAB_RED

public static final int COLOR_TAB_RED

The default red-component of the tab selected color

See Also:

Constant Field Values

COLOR_TAB_GREEN

public static final int COLOR_TAB_GREEN

The default green-component of the tab selected color

See Also:

Constant Field Values

COLOR_TAB_BLUE

public static final int COLOR_TAB_BLUE

The default blue-component of the tab selected color

See Also:

Constant Field Values

INTERVAL_MS_TRANS_CANVAS_REFRESH

public static final int INTERVAL_MS_TRANS_CANVAS_REFRESH

the default canvas refresh interval for running transformations

See Also:

Constant Field Values

SMALL_MARGIN

public static final int SMALL_MARGIN

margin between points of controls

See Also:

Constant Field Values

MEDUIM_MARGIN

public static final int MEDUIM_MARGIN

margin between points of controls

See Also:

Constant Field Values

Constructor Detail

ConstUI

public ConstUI()

Method Detail

getTreeLevel

public static final int getTreeLevel(org.eclipse.swt.widgets.TreeItem ti)

Determine the level of where the TreeItem is position in a tree.

Parameters:

ti - The TreeItem

Returns:

The level of the item in the tree

getTreeStrings

public static final String[] getTreeStrings(org.eclipse.swt.widgets.TreeItem ti)

Get an array of strings containing the path from the given TreeItem to the parent.

Parameters:

ti - The TreeItem to look at

Returns:

An array of string describing the path to the TreeItem.

getTreePath

public static final String getTreePath(org.eclipse.swt.widgets.TreeItem ti,
                                       int from)

Return the tree path seperated by Const.FILE_SEPARATOR, starting from a certain depth in the tree.

Parameters:

ti - The TreeItem to get the path for

from - The depth to start at, use 0 to get the complete tree.

Returns:

The tree path.

flipExpanded

public static final void flipExpanded(org.eclipse.swt.widgets.TreeItem ti)

Flips the TreeItem from expanded to not expanded or vice-versa.

Parameters:

ti - The TreeItem to flip.

findTreeItem

public static final org.eclipse.swt.widgets.TreeItem findTreeItem(org.eclipse.swt.widgets.TreeItem parent,
                                                                  String name)

findTreeItem

public static final org.eclipse.swt.widgets.TreeItem findTreeItem(org.eclipse.swt.widgets.TreeItem parent,
                                                                  String parentName,
                                                                  String name)

Finds a TreeItem with a certain label (name) in a (part of a) tree.

Parameters:

parent - The TreeItem where we start looking.

parentName - The name of the parent to match as well (null=not used)

name - The name or item label to look for.

Returns:

The TreeItem if the label was found, null if nothing was found.

displayMenu

public static void displayMenu(org.pentaho.ui.xul.containers.XulMenupopup xulMenuPopup,
                               org.eclipse.swt.widgets.Control control)

displayMenu

public static void displayMenu(org.eclipse.swt.widgets.Menu menu,
                               org.eclipse.swt.widgets.Control control)