BeanNode

java.lang.Object
- xal.extension.bricks.Brick
- - xal.extension.bricks.BeanNode<T>

All Implemented Interfaces:

DataListener

Direct Known Subclasses:

BorderNode, ViewNode
```
public abstract class BeanNode<T>
extends Brick
implements DataListener
```
brick which represents a Java Bean

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`_customBeanClassName` custom bean class name
`protected java.lang.String`	`_tag` tag for identifying this node
`protected static java.lang.String`	`BEAN_DATA_LABEL` data label from bean properties
`protected T`	`BEAN_OBJECT` bean object
`protected BeanProxy<T>`	`BEAN_PROXY` the bean proxy
`protected java.util.Map<java.lang.String,java.lang.Object>`	`BEAN_SETTINGS` bean settings

Fields inherited from class xal.extension.bricks.Brick
EVENT_PROXY, MESSAGE_CENTER, TREE_NODE

Constructor Summary

Constructors
Constructor and Description
`BeanNode(BeanNode<T> node)` Constructor
`BeanNode(BeanProxy<T> beanProxy)` Constructor
`BeanNode(BeanProxy<T> beanProxy, java.util.Map<java.lang.String,java.lang.Object> beanSettings, java.lang.String tag)` Primary Constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`applyBeanSettings()` apply the bean settings
`abstract java.lang.String`	`dataLabel()` Provides the name used to identify the class in an external data source.
`void`	`display()` Display the bean's window
`T`	`getBeanObject()` Get the bean object
`java.beans.BeanInfo`	`getBeanObjectBeanInfo()` Get the bean info of the view.
`BeanProxy<T>`	`getBeanProxy()` Get the view proxy
`java.lang.String`	`getClassName()` get the fully qualified class name
`java.lang.String`	`getCustomBeanClassName()` Get this node's custom bean class name
`java.lang.String`	`getJavaDeclarationSnippet()` Get the java declaration snippet
`java.lang.String`	`getJavaReferenceSnippet()` get the java reference snippet
`java.lang.String`	`getJythonReferenceSnippet()` get the jython reference snippet
`static DataListener`	`getPropertyArchiver(java.lang.String name, java.lang.Object value)` get the archiver of bean propertiers
`java.lang.Object`	`getPropertyValue(java.beans.PropertyDescriptor propertyDescriptor)` get the property value
`protected java.util.Map<java.lang.String,java.beans.PropertyDescriptor>`	`getProperyDescriptorTable()` Get the property descriptor table keyed by property name
`protected T`	`getPrototypeBean(BeanProxy<T> beanProxy)` get the bean instance
`java.lang.String`	`getShortClassName()` get the short version of the class name
`java.lang.String`	`getTag()` Get this node's tag
`ViewNodeContainer`	`getViewNodeContainer()` Get the containing node
`java.lang.String`	`getXALReferenceSnippet()` get the java reference snippet
`boolean`	`hasCustomBeanClass()` Determine whether this node has a custom bean class
`void`	`refreshDisplay()` refresh display
`void`	`setCustomBeanClassName(java.lang.String name)` Set this node's custom bean class name
`void`	`setPropertyValue(java.beans.PropertyDescriptor propertyDescriptor, java.lang.Object value)` update the property with the specified value
`void`	`setTag(java.lang.String tag)` Set this node's tag
`java.lang.String`	`toString()` get a label
`void`	`update(DataAdaptor adaptor)` Update the data based on the information provided by the data provider.
`void`	`write(DataAdaptor adaptor)` Write data to the data adaptor for storage.

Methods inherited from class xal.extension.bricks.Brick
addBrickListener, canAdd, canAddAll, canAddAllNodes, canAddNode, canAllBeSiblings, canAllNodesBeSiblings, canBeSibling, canNodeBeSibling, getContainingBrick, getParent, getTreeNode, isAncestorOf, removeBrickListener, removeFromParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - BEAN_DATA_LABEL
```
protected static final java.lang.String BEAN_DATA_LABEL
```
    data label from bean properties
    
    See Also:
    
    Constant Field Values
  - BEAN_OBJECT
```
protected final T BEAN_OBJECT
```
    bean object
  - BEAN_PROXY
```
protected final BeanProxy<T> BEAN_PROXY
```
    the bean proxy
  - BEAN_SETTINGS
```
protected final java.util.Map<java.lang.String,java.lang.Object> BEAN_SETTINGS
```
    bean settings
  - _tag
```
protected java.lang.String _tag
```
    tag for identifying this node
  - _customBeanClassName
```
protected java.lang.String _customBeanClassName
```
    custom bean class name
- Constructor Detail
  - BeanNode
```
public BeanNode(BeanProxy<T> beanProxy,
                java.util.Map<java.lang.String,java.lang.Object> beanSettings,
                java.lang.String tag)
```
    Primary Constructor
  - BeanNode
```
public BeanNode(BeanNode<T> node)
```
    Constructor
  - BeanNode
```
public BeanNode(BeanProxy<T> beanProxy)
```
    Constructor
- Method Detail
  - getBeanProxy
```
public BeanProxy<T> getBeanProxy()
```
    Get the view proxy
    
    Returns:
    
    the view proxy
  - getPrototypeBean
```
protected T getPrototypeBean(BeanProxy<T> beanProxy)
```
    get the bean instance
  - getBeanObject
```
public T getBeanObject()
```
    Get the bean object
  - getBeanObjectBeanInfo
```
public java.beans.BeanInfo getBeanObjectBeanInfo()
```
    Get the bean info of the view. Get the view's bean info
  - getTag
```
public java.lang.String getTag()
```
    Get this node's tag
    
    Returns:
    
    this node's tag
  - setTag
```
public void setTag(java.lang.String tag)
```
    Set this node's tag
    
    Parameters:
    
    tag - the new tag
  - hasCustomBeanClass
```
public boolean hasCustomBeanClass()
```
    Determine whether this node has a custom bean class
    
    Returns:
    
    true if this node has a custom bean class and false if not
  - getCustomBeanClassName
```
public java.lang.String getCustomBeanClassName()
```
    Get this node's custom bean class name
    
    Returns:
    
    this node's custom bean class name
  - setCustomBeanClassName
```
public void setCustomBeanClassName(java.lang.String name)
```
    Set this node's custom bean class name
    
    Parameters:
    
    name - the new custom bean class name
  - getClassName
```
public java.lang.String getClassName()
```
    get the fully qualified class name
    
    Returns:
    
    the custom class name if it exists or the prototype class name if there is no custom class
  - getShortClassName
```
public java.lang.String getShortClassName()
```
    get the short version of the class name
    
    Returns:
    
    the short version of the class name
  - getJythonReferenceSnippet
```
public java.lang.String getJythonReferenceSnippet()
```
    get the jython reference snippet
  - getJavaReferenceSnippet
```
public java.lang.String getJavaReferenceSnippet()
```
    get the java reference snippet
  - getXALReferenceSnippet
```
public java.lang.String getXALReferenceSnippet()
```
    get the java reference snippet
  - getJavaDeclarationSnippet
```
public java.lang.String getJavaDeclarationSnippet()
```
    Get the java declaration snippet
    
    Returns:
    
    the java declaration snippet
  - refreshDisplay
```
public void refreshDisplay()
```
    refresh display
  - applyBeanSettings
```
protected void applyBeanSettings()
```
    apply the bean settings
  - getProperyDescriptorTable
```
protected java.util.Map<java.lang.String,java.beans.PropertyDescriptor> getProperyDescriptorTable()
```
    Get the property descriptor table keyed by property name
  - getPropertyValue
```
public java.lang.Object getPropertyValue(java.beans.PropertyDescriptor propertyDescriptor)
                                  throws java.lang.Exception
```
    get the property value
    
    Throws:
    
    java.lang.Exception
  - setPropertyValue
```
public void setPropertyValue(java.beans.PropertyDescriptor propertyDescriptor,
                             java.lang.Object value)
```
    update the property with the specified value
  - getViewNodeContainer
```
public ViewNodeContainer getViewNodeContainer()
```
    Get the containing node
    
    Returns:
    
    the parent view node
  - display
```
public void display()
```
    Display the bean's window
  - dataLabel
```
public abstract java.lang.String dataLabel()
```
    Provides the name used to identify the class in an external data source.
    
    Specified by:
    
    dataLabel in interface DataListener
    
    Returns:
    
    a tag that identifies the receiver's type
  - update
```
public void update(DataAdaptor adaptor)
```
    Update the data based on the information provided by the data provider.
    
    Specified by:
    
    update in interface DataListener
    
    Parameters:
    
    adaptor - The adaptor from which to update the data
  - write
```
public void write(DataAdaptor adaptor)
```
    Write data to the data adaptor for storage.
    
    Specified by:
    
    write in interface DataListener
    
    Parameters:
    
    adaptor - The adaptor to which the receiver's data is written
  - getPropertyArchiver
```
public static DataListener getPropertyArchiver(java.lang.String name,
                                               java.lang.Object value)
```
    get the archiver of bean propertiers
  - toString
```
public java.lang.String toString()
```
    get a label
    
    Overrides:
    
    toString in class java.lang.Object

Class BeanNode<T>

Field Summary

Fields inherited from class xal.extension.bricks.Brick

Constructor Summary

Method Summary

Methods inherited from class xal.extension.bricks.Brick

Methods inherited from class java.lang.Object

Field Detail

BEAN_DATA_LABEL

BEAN_OBJECT

BEAN_PROXY

BEAN_SETTINGS

_tag

_customBeanClassName

Constructor Detail

BeanNode

BeanNode

BeanNode

Method Detail

getBeanProxy

getPrototypeBean

getBeanObject

getBeanObjectBeanInfo

getTag

setTag

hasCustomBeanClass

getCustomBeanClassName

setCustomBeanClassName

getClassName

getShortClassName

getJythonReferenceSnippet

getJavaReferenceSnippet

getXALReferenceSnippet

getJavaDeclarationSnippet

refreshDisplay

applyBeanSettings

getProperyDescriptorTable

getPropertyValue

setPropertyValue

getViewNodeContainer

display

dataLabel

update

write

getPropertyArchiver

toString