ucar.unidata.ui

Class ComponentGroup

java.lang.Object

ucar.unidata.collab.SharableImpl

ucar.unidata.collab.PropertiedThing

ucar.unidata.ui.ComponentHolder

ucar.unidata.ui.ComponentGroup

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, Sharable

Direct Known Subclasses:

IdvComponentGroup

public class ComponentGroup
extends ComponentHolder

Holds a group of display components

Version:

$Revision: 1.13 $

Author:

IDV Development Team

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JComponent	container The gui
static java.lang.String	LAYOUT_BORDER type of layout
static java.lang.String	LAYOUT_DESKTOP type of layout
static java.lang.String	LAYOUT_GRAPH type of layout
static java.lang.String	LAYOUT_GRID type of layout
static java.lang.String	LAYOUT_GRIDBAG type of layout
static java.lang.String	LAYOUT_HSPLIT type of layout
static java.util.List	LAYOUT_LIST _more_
static java.lang.String	LAYOUT_MENU type of layout
static java.lang.String[]	LAYOUT_NAMES user readable names of layouts
static java.lang.String	LAYOUT_TABS type of layout
static java.lang.String	LAYOUT_TREE type of layout
static java.lang.String	LAYOUT_VSPLIT type of layout
static java.lang.String[]	LAYOUTS all of the layouts
protected javax.swing.JComponent	outerContainer outermost gui component
protected javax.swing.JTabbedPane	tabbedPane Tabbed pane

Fields inherited from class ucar.unidata.ui.ComponentHolder

ATTR_NAME, BORDER_NAMES, BORDERS, displayBtn, header, isRemoved, nameFld, parent

Fields inherited from class ucar.unidata.collab.PropertiedThing

propertiesDialog

Constructor Summary

Constructors

Constructor and Description
ComponentGroup() default ctor
ComponentGroup(java.lang.String name) ctor

Method Summary

Modifier and Type	Method and Description
void	addComponent(ComponentHolder displayComponent) Add the wrapper
void	addComponent(ComponentHolder displayComponent, int index) Add the wrapper
protected boolean	applyProperties() Apply properties
protected void	doDrop(java.lang.Object obj) _more_
javax.swing.JComponent	doMakeContents() Create and return the gui contents
void	doRemove() do cleanup
boolean	dropOk(java.lang.Object object) _more_
void	editLayout() _more_
java.util.List	findComponentsWithType(java.lang.Class compClass) Recursively find all contained components of the given class
java.util.List	getDisplayComponents() Get the DisplayComponents property.
int	getGridColumns() Get the GridColumns property.
boolean	getIconified() Get the Iconified property.
java.awt.Rectangle	getLastPosition() Get the LastPosition property.
java.lang.String	getLayout() Get the Layout property.
int	getNumColumns() Get the NumColumns property.
int	getNumRows() Get the NumRows property.
protected java.util.List	getPopupMenuItems(java.util.List items) Make the edit menu items
protected void	getPropertiesComponents(java.util.List comps, int tabIdx) Show dialog
java.lang.String	getTypeName() What type of thing is this
int	indexOf(ComponentHolder displayComponent) What is the index of the child component
void	initWith(org.w3c.dom.Element node) _more_
static boolean	isAncestor(ComponentGroup parent, ComponentHolder descendant) _more_
static void	main(java.lang.String[] args) _more_
javax.swing.tree.DefaultMutableTreeNode	makeTree(javax.swing.tree.DefaultMutableTreeNode parent) _more_
void	print(java.lang.String tab) _more_
void	redoLayout() Layout components
void	removeComponent(ComponentHolder displayComponent) remove the wrapper
void	setDisplayComponents(java.util.List value) Set the DisplayComponents property.
void	setGridColumns(int value) Set the GridColumns property.
void	setIconified(boolean value) Set the Iconified property.
void	setLastPosition(java.awt.Rectangle value) Set the LastPosition property.
void	setLayout(java.lang.String value) Set the Layout property.
void	setNumColumns(int value) Set the NumColumns property.
void	setNumRows(int value) Set the NumRows property.
void	setRowsColumns(int rows, int cols) Set layout
void	setState(org.w3c.dom.Element node) _more_
protected void	subtreeChanged() _more_
java.lang.String	toString() to string
protected javax.swing.JComponent	wrapContents(javax.swing.JComponent contents) _more_
java.lang.String[]	xxxxgetPropertyTabs() _more_

Methods inherited from class ucar.unidata.ui.ComponentHolder

clearContents, doMakeHeader, getBeingShown, getBorder, getBorderLayoutLocation, getCategory, getContents, getHierachicalName, getIcon, getInternalFrame, getInternalFrameShown, getLayoutRect, getName, getParent, getRoot, getShowHeader, removeDisplayComponent, setBorder, setBorder, setBorderLayoutLocation, setCategory, setInternalFrameShown, setLayoutRect, setName, setParent, setShowHeader, showPopup

Methods inherited from class ucar.unidata.collab.PropertiedThing

addPropertyChangeListener, doApplyProperties, firePropertyChange, firePropertyChange, getPropertyListeners, getPropertyTabs, isShowing, propertyChange, removePropertyChangeListener, showProperties, showProperties

Methods inherited from class ucar.unidata.collab.SharableImpl

applySharableProperties, doShare, doShare, doShareExternal, doShareInternal, getReceiveShareTime, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, receiveShareData, removeSharable, setReceiveShareTime, setShareGroup, setSharing, setUniqueId, showSharableDialog

Methods inherited from class java.lang.Object

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

Field Detail

LAYOUT_GRIDBAG

public static final java.lang.String LAYOUT_GRIDBAG

type of layout

See Also:

Constant Field Values

LAYOUT_GRID

public static final java.lang.String LAYOUT_GRID

type of layout

See Also:

Constant Field Values

LAYOUT_TABS

public static final java.lang.String LAYOUT_TABS

type of layout

See Also:

Constant Field Values

LAYOUT_HSPLIT

public static final java.lang.String LAYOUT_HSPLIT

type of layout

See Also:

Constant Field Values

LAYOUT_VSPLIT

public static final java.lang.String LAYOUT_VSPLIT

type of layout

See Also:

Constant Field Values

LAYOUT_GRAPH

public static final java.lang.String LAYOUT_GRAPH

type of layout

See Also:

Constant Field Values

LAYOUT_TREE

public static final java.lang.String LAYOUT_TREE

type of layout

See Also:

Constant Field Values

LAYOUT_BORDER

public static final java.lang.String LAYOUT_BORDER

type of layout

See Also:

Constant Field Values

LAYOUT_DESKTOP

public static final java.lang.String LAYOUT_DESKTOP

type of layout

See Also:

Constant Field Values

LAYOUT_MENU

public static final java.lang.String LAYOUT_MENU

type of layout

See Also:

Constant Field Values

LAYOUT_NAMES

public static final java.lang.String[] LAYOUT_NAMES

user readable names of layouts

LAYOUTS

public static final java.lang.String[] LAYOUTS

all of the layouts

LAYOUT_LIST

public static final java.util.List LAYOUT_LIST

_more_

container

protected javax.swing.JComponent container

The gui

outerContainer

protected javax.swing.JComponent outerContainer

outermost gui component

tabbedPane

protected javax.swing.JTabbedPane tabbedPane

Tabbed pane

Constructor Detail

ComponentGroup

public ComponentGroup()

default ctor

ComponentGroup

public ComponentGroup(java.lang.String name)

ctor

Parameters:

name - name

Method Detail

initWith

public void initWith(org.w3c.dom.Element node)

_more_

Overrides:

initWith in class ComponentHolder

Parameters:

node - _more_

setState

public void setState(org.w3c.dom.Element node)

_more_

Overrides:

setState in class ComponentHolder

Parameters:

node - _more_

getTypeName

public java.lang.String getTypeName()

What type of thing is this

Overrides:

getTypeName in class ComponentHolder

Returns:

type name

doMakeContents

public javax.swing.JComponent doMakeContents()

Create and return the gui contents

Overrides:

doMakeContents in class ComponentHolder

Returns:

gui contents

wrapContents

protected javax.swing.JComponent wrapContents(javax.swing.JComponent contents)

_more_

Overrides:

wrapContents in class ComponentHolder

Parameters:

contents - _more_

Returns:

_more_

dropOk

public boolean dropOk(java.lang.Object object)

_more_

Parameters:

object - _more_

Returns:

_more_

doDrop

protected void doDrop(java.lang.Object obj)

_more_

Parameters:

obj - _more_

getPopupMenuItems

protected java.util.List getPopupMenuItems(java.util.List items)

Make the edit menu items

Overrides:

getPopupMenuItems in class ComponentHolder

Parameters:

items - Holds the menu items

Returns:

The list of items

xxxxgetPropertyTabs

public java.lang.String[] xxxxgetPropertyTabs()

_more_

Returns:

_more_

getPropertiesComponents

protected void getPropertiesComponents(java.util.List comps,
                                       int tabIdx)

Show dialog

Overrides:

getPropertiesComponents in class ComponentHolder

Parameters:

comps - List of components

tabIdx - which tab

makeTree

public javax.swing.tree.DefaultMutableTreeNode makeTree(javax.swing.tree.DefaultMutableTreeNode parent)

_more_

Overrides:

makeTree in class ComponentHolder

Parameters:

parent - _more_

Returns:

_more_

findComponentsWithType

public java.util.List findComponentsWithType(java.lang.Class compClass)

Recursively find all contained components of the given class

Parameters:

compClass - The class to look for

Returns:

List of components

redoLayout

public void redoLayout()

Layout components

editLayout

public void editLayout()

_more_

addComponent

public void addComponent(ComponentHolder displayComponent)

Add the wrapper

Parameters:

displayComponent - new one

indexOf

public int indexOf(ComponentHolder displayComponent)

What is the index of the child component

Parameters:

displayComponent - child component

Returns:

its index

addComponent

public void addComponent(ComponentHolder displayComponent,
                         int index)

Add the wrapper

Parameters:

displayComponent - new one

index - Where

subtreeChanged

protected void subtreeChanged()

_more_

applyProperties

protected boolean applyProperties()

Apply properties

Overrides:

applyProperties in class ComponentHolder

Returns:

Was successful

removeComponent

public void removeComponent(ComponentHolder displayComponent)

remove the wrapper

Parameters:

displayComponent - the wrapper to remove

doRemove

public void doRemove()

do cleanup

Overrides:

doRemove in class ComponentHolder

setDisplayComponents

public void setDisplayComponents(java.util.List value)

Set the DisplayComponents property.

Parameters:

value - The new value for DisplayComponents

getDisplayComponents

public java.util.List getDisplayComponents()

Get the DisplayComponents property.

Returns:

The DisplayComponents

setRowsColumns

public void setRowsColumns(int rows,
                           int cols)

Set layout

Parameters:

rows - rows

cols - cols

setNumRows

public void setNumRows(int value)

Set the NumRows property.

Parameters:

value - The new value for NumRows

getNumRows

public int getNumRows()

Get the NumRows property.

Returns:

The NumRows

setNumColumns

public void setNumColumns(int value)

Set the NumColumns property.

Parameters:

value - The new value for NumColumns

getNumColumns

public int getNumColumns()

Get the NumColumns property.

Returns:

The NumColumns

toString

public java.lang.String toString()

to string

Overrides:

toString in class ComponentHolder

Returns:

string

setLastPosition

public void setLastPosition(java.awt.Rectangle value)

Set the LastPosition property.

Parameters:

value - The new value for LastPosition

getLastPosition

public java.awt.Rectangle getLastPosition()

Get the LastPosition property.

Returns:

The LastPosition

setIconified

public void setIconified(boolean value)

Set the Iconified property.

Parameters:

value - The new value for Iconified

getIconified

public boolean getIconified()

Get the Iconified property.

Returns:

The Iconified

setLayout

public void setLayout(java.lang.String value)

Set the Layout property.

Parameters:

value - The new value for Layout

getLayout

public java.lang.String getLayout()

Get the Layout property.

Returns:

The Layout

setGridColumns

public void setGridColumns(int value)

Set the GridColumns property.

Parameters:

value - The new value for GridColumns

getGridColumns

public int getGridColumns()

Get the GridColumns property.

Returns:

The GridColumns

main

public static void main(java.lang.String[] args)

_more_

Parameters:

args - _more_

isAncestor

public static boolean isAncestor(ComponentGroup parent,
                                 ComponentHolder descendant)

_more_

Parameters:

parent - _more_

descendant - _more_

Returns:

_more_

print

public void print(java.lang.String tab)

_more_

Overrides:

print in class ComponentHolder

Parameters:

tab - _more_