ComponentHolder (Unidata IDV API v6.2u2)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ComponentGroup, HtmlComponent, IdvComponentHolder
```
public class ComponentHolder
extends PropertiedThing
```
Version:

$Revision: 1.13 $

Author:

IDV Development Team

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTR_NAME` _more_
`static java.lang.String[]`	`BORDER_NAMES` _more_
`static java.lang.String[]`	`BORDERS` _more_
`protected javax.swing.JButton`	`displayBtn` _more_
`protected javax.swing.JComponent`	`header` _more_
`protected boolean`	`isRemoved` _more_
`protected javax.swing.JTextField`	`nameFld` _more_
`protected ComponentGroup`	`parent` _more_

Fields inherited from class ucar.unidata.collab.PropertiedThing
propertiesDialog

Constructor Summary

Constructors
Constructor and Description
`ComponentHolder()` _more_
`ComponentHolder(java.lang.String name)` _more_
`ComponentHolder(java.lang.String name, javax.swing.JComponent contents)` _more_

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`applyProperties()` _more_
`protected void`	`clearContents()` _more_
`javax.swing.JComponent`	`doMakeContents()` _more_
`protected javax.swing.JComponent`	`doMakeHeader()` _more_
`void`	`doRemove()` _more_
`boolean`	`getBeingShown()` _more_
`java.lang.String`	`getBorder()` Get the Border property.
`java.lang.String`	`getBorderLayoutLocation()` Get the BorderLayoutLocation property.
`java.lang.String`	`getCategory()` Get the Category property.
`javax.swing.JComponent`	`getContents()` _more_
`java.lang.String`	`getHierachicalName()` _more_
`javax.swing.ImageIcon`	`getIcon()` _more_
`javax.swing.JInternalFrame`	`getInternalFrame()` _more_
`boolean`	`getInternalFrameShown()` Get the InternalFrameShow property.
`java.awt.Rectangle`	`getLayoutRect()` Get the LayoutRect property.
`java.lang.String`	`getName()` Get the Name property.
`ComponentGroup`	`getParent()` Get the Parent property.
`protected java.util.List`	`getPopupMenuItems(java.util.List items)` Get the menu items for the popup menu
`protected void`	`getPropertiesComponents(java.util.List comps, int tabIdx)` _more_
`ComponentGroup`	`getRoot()` _more_
`boolean`	`getShowHeader()` Get the ShowHeader property.
`java.lang.String`	`getTypeName()` _more_
`void`	`initWith(org.w3c.dom.Element node)` _more_
`javax.swing.tree.DefaultMutableTreeNode`	`makeTree(javax.swing.tree.DefaultMutableTreeNode parent)` _more_
`void`	`print(java.lang.String tab)` _more_
`boolean`	`removeDisplayComponent()` Remove me
`protected void`	`setBorder(javax.swing.JComponent comp)` _more_
`void`	`setBorder(java.lang.String value)` Set the Border property.
`void`	`setBorderLayoutLocation(java.lang.String value)` Set the BorderLayoutLocation property.
`void`	`setCategory(java.lang.String value)` Set the Category property.
`void`	`setInternalFrameShown(boolean value)` Set the InternalFrameShow property.
`void`	`setLayoutRect(java.awt.Rectangle value)` Set the LayoutRect property.
`void`	`setName(java.lang.String value)` Set the Name property.
`void`	`setParent(ComponentGroup newParent)` Set the Parent property.
`void`	`setShowHeader(boolean value)` Set the ShowHeader property.
`void`	`setState(org.w3c.dom.Element node)` _more_
`void`	`showPopup(javax.swing.JComponent where, int x, int y)` SHow the popup menu
`java.lang.String`	`toString()` _more_
`protected javax.swing.JComponent`	`wrapContents(javax.swing.JComponent contents)` _more_

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
  - ATTR_NAME
```
public static final java.lang.String ATTR_NAME
```
    _more_
    
    See Also:
    
    Constant Field Values
  - BORDERS
```
public static final java.lang.String[] BORDERS
```
    _more_
  - BORDER_NAMES
```
public static final java.lang.String[] BORDER_NAMES
```
    _more_
  - nameFld
```
protected javax.swing.JTextField nameFld
```
    _more_
  - displayBtn
```
protected javax.swing.JButton displayBtn
```
    _more_
  - header
```
protected javax.swing.JComponent header
```
    _more_
  - parent
```
protected ComponentGroup parent
```
    _more_
  - isRemoved
```
protected boolean isRemoved
```
    _more_
- Constructor Detail
  - ComponentHolder
```
public ComponentHolder()
```
    _more_
  - ComponentHolder
```
public ComponentHolder(java.lang.String name)
```
    _more_
    
    Parameters:
    
    name - _more_
  - ComponentHolder
```
public ComponentHolder(java.lang.String name,
                       javax.swing.JComponent contents)
```
    _more_
    
    Parameters:
    
    name - _more_
    
    contents - _more_
- Method Detail
  - getRoot
```
public ComponentGroup getRoot()
```
    _more_
    
    Returns:
    
    _more_
  - getInternalFrame
```
public javax.swing.JInternalFrame getInternalFrame()
```
    _more_
    
    Returns:
    
    _more_
  - getHierachicalName
```
public java.lang.String getHierachicalName()
```
    _more_
    
    Returns:
    
    _more_
  - setState
```
public void setState(org.w3c.dom.Element node)
```
    _more_
    
    Parameters:
    
    node - _more_
  - initWith
```
public void initWith(org.w3c.dom.Element node)
```
    _more_
    
    Parameters:
    
    node - _more_
  - clearContents
```
protected void clearContents()
```
    _more_
  - getContents
```
public javax.swing.JComponent getContents()
```
    _more_
    
    Returns:
    
    _more_
  - doMakeHeader
```
protected javax.swing.JComponent doMakeHeader()
```
    _more_
    
    Returns:
    
    _more_
  - wrapContents
```
protected javax.swing.JComponent wrapContents(javax.swing.JComponent contents)
```
    _more_
    
    Parameters:
    
    contents - _more_
    
    Returns:
    
    _more_
  - doMakeContents
```
public javax.swing.JComponent doMakeContents()
```
    _more_
    
    Returns:
    
    _more_
  - getTypeName
```
public java.lang.String getTypeName()
```
    _more_
    
    Returns:
    
    _more_
  - showPopup
```
public void showPopup(javax.swing.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(java.util.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(javax.swing.JComponent comp)
```
    _more_
    
    Parameters:
    
    comp - _more_
  - makeTree
```
public javax.swing.tree.DefaultMutableTreeNode makeTree(javax.swing.tree.DefaultMutableTreeNode parent)
```
    _more_
    
    Parameters:
    
    parent - _more_
    
    Returns:
    
    _more_
  - getPopupMenuItems
```
protected java.util.List getPopupMenuItems(java.util.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 java.lang.String toString()
```
    _more_
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    _more_
  - print
```
public void print(java.lang.String tab)
```
    _more_
    
    Parameters:
    
    tab - _more_
  - doRemove
```
public void doRemove()
```
    _more_
  - setName
```
public void setName(java.lang.String value)
```
    Set the Name property.
    
    Parameters:
    
    value - The new value for Name
  - getName
```
public java.lang.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(java.awt.Rectangle value)
```
    Set the LayoutRect property.
    
    Parameters:
    
    value - The new value for LayoutRect
  - getLayoutRect
```
public java.awt.Rectangle getLayoutRect()
```
    Get the LayoutRect property.
    
    Returns:
    
    The LayoutRect
  - setCategory
```
public void setCategory(java.lang.String value)
```
    Set the Category property.
    
    Parameters:
    
    value - The new value for Category
  - getCategory
```
public java.lang.String getCategory()
```
    Get the Category property.
    
    Returns:
    
    The Category
  - getIcon
```
public javax.swing.ImageIcon getIcon()
```
    _more_
    
    Returns:
    
    _more_
  - 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(java.lang.String value)
```
    Set the Border property.
    
    Parameters:
    
    value - The new value for Border
  - getBorder
```
public java.lang.String getBorder()
```
    Get the Border property.
    
    Returns:
    
    The Border
  - setBorderLayoutLocation
```
public void setBorderLayoutLocation(java.lang.String value)
```
    Set the BorderLayoutLocation property.
    
    Parameters:
    
    value - The new value for BorderLayoutLocation
  - getBorderLayoutLocation
```
public java.lang.String getBorderLayoutLocation()
```
    Get the BorderLayoutLocation property.
    
    Returns:
    
    The BorderLayoutLocation
  - setInternalFrameShown
```
public void setInternalFrameShown(boolean value)
```
    Set the InternalFrameShow property.
    
    Parameters:
    
    value - The new value for InternalFrameShow
  - getInternalFrameShown
```
public boolean getInternalFrameShown()
```
    Get the InternalFrameShow property.
    
    Returns:
    
    The InternalFrameShow

Class ComponentHolder

Field Summary

Fields inherited from class ucar.unidata.collab.PropertiedThing

Constructor Summary

Method Summary

Methods inherited from class ucar.unidata.collab.PropertiedThing

Methods inherited from class ucar.unidata.collab.SharableImpl

Methods inherited from class java.lang.Object

Field Detail

ATTR_NAME

BORDERS

BORDER_NAMES

nameFld

displayBtn

header

parent

isRemoved

Constructor Detail

ComponentHolder

ComponentHolder

ComponentHolder

Method Detail

getRoot

getInternalFrame

getHierachicalName

setState

initWith

clearContents

getContents

doMakeHeader

wrapContents

doMakeContents

getTypeName

showPopup

getPropertiesComponents

applyProperties

setBorder

makeTree

getPopupMenuItems

getBeingShown

removeDisplayComponent

toString

print

doRemove

setName

getName

setParent

getParent

setLayoutRect

getLayoutRect

setCategory

getCategory

getIcon

setShowHeader

getShowHeader

setBorder

getBorder

setBorderLayoutLocation

getBorderLayoutLocation

setInternalFrameShown

getInternalFrameShown