ucar.unidata.ui
Class ComponentHolder

java.lang.Object
  ucar.unidata.collab.SharableImpl
      ucar.unidata.collab.PropertiedThing
          ucar.unidata.ui.ComponentHolder

All Implemented Interfaces:

PropertyChangeListener, EventListener, Sharable

Direct Known Subclasses:

ComponentGroup, HtmlComponent, IdvComponentHolder

public class ComponentHolder
extends PropertiedThing

Version:

$Revision: 1.13 $

Author:

IDV Development Team

Field Summary

static String	ATTR_NAME _more_
static String[]	BORDER_NAMES _more_
static String[]	BORDERS _more_
protected JButton	displayBtn _more_
protected JComponent	header _more_
protected boolean	isRemoved _more_
protected JTextField	nameFld _more_
protected ComponentGroup	parent _more_

Fields inherited from class ucar.unidata.collab.PropertiedThing

propertiesDialog

Constructor Summary

ComponentHolder()
_more_

ComponentHolder(String name)
_more_

ComponentHolder(String name, JComponent contents)
_more_

Method Summary

protected boolean	applyProperties() _more_
protected void	clearContents() _more_
JComponent	doMakeContents() _more_
protected JComponent	doMakeHeader()
void	doRemove() _more_
boolean	getBeingShown() _more_
String	getBorder() Get the Border property.
String	getBorderLayoutLocation() Get the BorderLayoutLocation property.
String	getCategory() Get the Category property.
JComponent	getContents() _more_
String	getHierachicalName()
ImageIcon	getIcon()
JInternalFrame	getInternalFrame() _more_
Rectangle	getLayoutRect() Get the LayoutRect property.
String	getName() Get the Name property.
ComponentGroup	getParent() Get the Parent property.
protected List	getPopupMenuItems(List items) Get the menu items for the popup menu
protected void	getPropertiesComponents(List comps, int tabIdx) _more_
ComponentGroup	getRoot()
boolean	getShowHeader() Get the ShowHeader property.
String	getTypeName() _more_
void	initWith(Element node) _more_
DefaultMutableTreeNode	makeTree(DefaultMutableTreeNode parent) _more_
void	print(String tab) _more_
boolean	removeDisplayComponent() Remove me
protected void	setBorder(JComponent comp) _more_
void	setBorder(String value) Set the Border property.
void	setBorderLayoutLocation(String value) Set the BorderLayoutLocation property.
void	setCategory(String value) Set the Category property.
void	setLayoutRect(Rectangle value) Set the LayoutRect property.
void	setName(String value) Set the Name property.
void	setParent(ComponentGroup newParent) Set the Parent property.
void	setShowHeader(boolean value) Set the ShowHeader property.
void	setState(Element node) _more_
void	showPopup(JComponent where, int x, int y) SHow the popup menu
String	toString() _more_
protected JComponent	wrapContents(JComponent contents)

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, getSharablePropertiesComponent, getShareGroup, getSharing, getUniqueId, initSharable, receiveShareData, removeSharable, setShareGroup, setSharing, setUniqueId, showSharableDialog

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME

public static final String ATTR_NAME

_more_

See Also:

Constant Field Values

BORDERS

public static final String[] BORDERS

_more_

BORDER_NAMES

public static final String[] BORDER_NAMES

_more_

nameFld

protected JTextField nameFld

_more_

displayBtn

protected JButton displayBtn

_more_

header

protected JComponent header

_more_

parent

protected ComponentGroup parent

_more_

isRemoved

protected boolean isRemoved

_more_

Constructor Detail

ComponentHolder

public ComponentHolder()

_more_

ComponentHolder

public ComponentHolder(String name)

_more_

Parameters:

name - _more_

ComponentHolder

public ComponentHolder(String name,
                       JComponent contents)

_more_

Parameters:

name - _more_

contents - _more_

Method Detail

getRoot

public ComponentGroup getRoot()

getInternalFrame

public JInternalFrame getInternalFrame()

_more_

Returns:

_more_

getHierachicalName

public String getHierachicalName()

setState

public void setState(Element node)

_more_

Parameters:

node - _more_

initWith

public void initWith(Element node)

_more_

Parameters:

node - _more_

clearContents

protected void clearContents()

_more_

getContents

public JComponent getContents()

_more_

Returns:

_more_

doMakeHeader

protected JComponent doMakeHeader()

wrapContents

protected JComponent wrapContents(JComponent contents)

doMakeContents

public JComponent doMakeContents()

_more_

Returns:

_more_

getTypeName

public String getTypeName()

_more_

Returns:

_more_

showPopup

public void showPopup(JComponent where,
                      int x,
                      int y)

SHow the popup menu

Parameters:

where - component to show near to

x - x

y - y

getPropertiesComponents

protected void getPropertiesComponents(List comps,
                                       int tabIdx)

_more_

Overrides:

getPropertiesComponents in class PropertiedThing

Parameters:

comps - _more_

tabIdx - _more_

applyProperties

protected boolean applyProperties()

_more_

Overrides:

applyProperties in class PropertiedThing

Returns:

_more_

setBorder

protected void setBorder(JComponent comp)

_more_

Parameters:

comp - _more_

makeTree

public DefaultMutableTreeNode makeTree(DefaultMutableTreeNode parent)

_more_

Parameters:

parent - _more_

Returns:

_more_

getPopupMenuItems

protected List getPopupMenuItems(List items)

Get the menu items for the popup menu

Parameters:

items - List of items to add to

Returns:

The items list

getBeingShown

public boolean getBeingShown()

_more_

Returns:

_more_

removeDisplayComponent

public boolean removeDisplayComponent()

Remove me

Returns:

was removed

toString

public String toString()

_more_

Overrides:

toString in class Object

Returns:

_more_

print

public void print(String tab)

_more_

Parameters:

tab - _more_

doRemove

public void doRemove()

_more_

setName

public void setName(String value)

Set the Name property.

Parameters:

value - The new value for Name

getName

public String getName()

Get the Name property.

Returns:

The Name

setParent

public void setParent(ComponentGroup newParent)

Set the Parent property.

Parameters:

newParent - _more_

getParent

public ComponentGroup getParent()

Get the Parent property.

Returns:

The Parent

setLayoutRect

public void setLayoutRect(Rectangle value)

Set the LayoutRect property.

Parameters:

value - The new value for LayoutRect

getLayoutRect

public Rectangle getLayoutRect()

Get the LayoutRect property.

Returns:

The LayoutRect

setCategory

public void setCategory(String value)

Set the Category property.

Parameters:

value - The new value for Category

getCategory

public String getCategory()

Get the Category property.

Returns:

The Category

getIcon

public ImageIcon getIcon()

setShowHeader

public void setShowHeader(boolean value)

Set the ShowHeader property.

Parameters:

value - The new value for ShowHeader

getShowHeader

public boolean getShowHeader()

Get the ShowHeader property.

Returns:

The ShowHeader

setBorder

public void setBorder(String value)

Set the Border property.

Parameters:

value - The new value for Border

getBorder

public String getBorder()

Get the Border property.

Returns:

The Border

setBorderLayoutLocation

public void setBorderLayoutLocation(String value)

Set the BorderLayoutLocation property.

Parameters:

value - The new value for BorderLayoutLocation

getBorderLayoutLocation

public String getBorderLayoutLocation()

Get the BorderLayoutLocation property.

Returns:

The BorderLayoutLocation