xal.extension.bricks

Class ViewNode

java.lang.Object

xal.extension.bricks.Brick

xal.extension.bricks.BeanNode<java.awt.Component>

xal.extension.bricks.ViewNode

All Implemented Interfaces:

BrickListener, ViewNodeContainer, DataListener

public class ViewNode
extends BeanNode<java.awt.Component>
implements ViewNodeContainer

brick which represents a view

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ViewNode.ComponentEventHandler handle component events
protected class	ViewNode.DropHandler handle drop events

Field Summary

Fields

Modifier and Type	Field and Description
protected BorderNode	_borderNode the associated border node if any
static java.lang.String	DATA_LABEL data label

Fields inherited from class xal.extension.bricks.BeanNode

_customBeanClassName, _tag, BEAN_DATA_LABEL, BEAN_OBJECT, BEAN_PROXY, BEAN_SETTINGS

Fields inherited from class xal.extension.bricks.Brick

EVENT_PROXY, MESSAGE_CENTER, TREE_NODE

Constructor Summary

Constructors

Constructor and Description
ViewNode(ViewNode node) Constructor
ViewNode(ViewProxy<java.awt.Component> viewProxy) Primary Constructor
ViewNode(ViewProxy<java.awt.Component> viewProxy, java.util.Map<java.lang.String,java.lang.Object> beanSettings, java.lang.String tag) Primary Constructor

Method Summary

Modifier and Type	Method and Description
void	add(java.util.List<BeanProxy<?>> beanProxies) Add the beans to this node
void	addNodes(java.util.List<BeanNode<?>> nodes) Add the views nodes to this node
boolean	canAdd(BeanProxy<?> beanProxy) Determine if the brick can add the specified view
java.lang.String	dataLabel() Provides the name used to identify the class in an external data source.
void	display() Display the bean's window
protected BorderNode	getBorderNode() get the border node
java.awt.Container	getContainer() Get the container.
static ViewNode	getInstance(DataAdaptor adaptor) generator
protected java.awt.Component	getPrototypeBean(BeanProxy<java.awt.Component> beanProxy) get the bean instance
int	getTreeIndexOffsetFromViewIndex() Get the tree index offset from the view index
java.awt.Component	getView() Get the view.
int	getViewIndex(ViewNode node) Get the index of the view node in the container
ViewProxy<java.awt.Component>	getViewProxy() Get the view proxy
java.awt.Window	getWindow() get the containing or being the view
void	insertSiblingNodes(java.util.List<BeanNode<?>> nodes) Insert the specified view nodes immediately above this node
void	insertSiblings(java.util.List<BeanProxy<?>> beanProxies) Insert the views in this node beginning at the specified index
void	insertViewNode(ViewNode node, int viewIndex) Insert the view node in this node beginning at the specified index
boolean	isWindow() Determine if the underlying view is a window
void	moveDownNodes(java.util.List<BeanNode<?>> nodes) Move the specified nodes down
void	moveUpNodes(java.util.List<BeanNode<?>> nodes) Move the specified nodes up
void	nodesAdded(java.lang.Object source, Brick container, java.util.List<BeanNode<?>> nodes) Handle the event in which nodes have been added to a container
void	nodesRemoved(java.lang.Object source, Brick container, java.util.List<BeanNode<?>> nodes) Handle the event in which nodes have been removed from a container
void	propertyChanged(BeanNode<?> beanNode, java.beans.PropertyDescriptor propertyDescriptor, java.lang.Object value) Handle the event in which a bean's property has been changed
void	refreshDisplay() refresh display
void	removeFromParent() Remove this brick from its parent
void	removeNode(BeanNode<?> node) Remove the view node from this container
void	removeNodes(java.util.List<BeanNode<?>> nodes) Remove the view nodes from this container
protected void	setBorderNode(BorderNode node) set the border node
void	treeNeedsRefresh(java.lang.Object source, Brick brick) Handle the event in which a brick's tree path needs refresh
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.BeanNode

applyBeanSettings, getBeanObject, getBeanObjectBeanInfo, getBeanProxy, getClassName, getCustomBeanClassName, getJavaDeclarationSnippet, getJavaReferenceSnippet, getJythonReferenceSnippet, getPropertyArchiver, getPropertyValue, getProperyDescriptorTable, getShortClassName, getTag, getViewNodeContainer, getXALReferenceSnippet, hasCustomBeanClass, setCustomBeanClassName, setPropertyValue, setTag, toString

Methods inherited from class xal.extension.bricks.Brick

addBrickListener, canAddAll, canAddAllNodes, canAddNode, canAllBeSiblings, canAllNodesBeSiblings, canBeSibling, canNodeBeSibling, getContainingBrick, getParent, getTreeNode, isAncestorOf, removeBrickListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface xal.extension.bricks.ViewNodeContainer

canAddAll, canAddAllNodes, canAddNode, canAllBeSiblings, canAllNodesBeSiblings, canBeSibling

Field Detail

DATA_LABEL

public static java.lang.String DATA_LABEL

data label

_borderNode

protected BorderNode _borderNode

the associated border node if any

Constructor Detail

ViewNode

public ViewNode(ViewProxy<java.awt.Component> viewProxy,
                java.util.Map<java.lang.String,java.lang.Object> beanSettings,
                java.lang.String tag)

Primary Constructor

ViewNode

public ViewNode(ViewProxy<java.awt.Component> viewProxy)

Primary Constructor

ViewNode

public ViewNode(ViewNode node)

Constructor

Method Detail

getInstance

public static ViewNode getInstance(DataAdaptor adaptor)

generator

getPrototypeBean

protected java.awt.Component getPrototypeBean(BeanProxy<java.awt.Component> beanProxy)

get the bean instance

Overrides:

getPrototypeBean in class BeanNode<java.awt.Component>

getView

public java.awt.Component getView()

Get the view.

Returns:

the view

getViewProxy

public ViewProxy<java.awt.Component> getViewProxy()

Get the view proxy

Returns:

the view proxy

getViewIndex

public int getViewIndex(ViewNode node)

Get the index of the view node in the container

Parameters:

node - the node to locate

Returns:

the index of the view in the container or -1 if it isn't contained in this node

isWindow

public boolean isWindow()

Determine if the underlying view is a window

Returns:

true if the view is a window and false if not

getContainer

public java.awt.Container getContainer()

Get the container.

Returns:

the view as a container

canAdd

public boolean canAdd(BeanProxy<?> beanProxy)

Determine if the brick can add the specified view

Specified by:

canAdd in interface ViewNodeContainer

Specified by:

canAdd in class Brick

Returns:

true if it can add the specified view and false if not

add

public void add(java.util.List<BeanProxy<?>> beanProxies)

Add the beans to this node

Specified by:

add in interface ViewNodeContainer

Parameters:

beanProxies - the beans to add to this node

addNodes

public void addNodes(java.util.List<BeanNode<?>> nodes)

Add the views nodes to this node

Specified by:

addNodes in interface ViewNodeContainer

Parameters:

nodes - the nodes to add to this node

insertSiblings

public void insertSiblings(java.util.List<BeanProxy<?>> beanProxies)

Insert the views in this node beginning at the specified index

Specified by:

insertSiblings in interface ViewNodeContainer

Parameters:

beanProxies - the views to add to this node

getTreeIndexOffsetFromViewIndex

public int getTreeIndexOffsetFromViewIndex()

Get the tree index offset from the view index

Specified by:

getTreeIndexOffsetFromViewIndex in interface ViewNodeContainer

Returns:

the tree index offset

insertViewNode

public void insertViewNode(ViewNode node,
                           int viewIndex)

Insert the view node in this node beginning at the specified index

Specified by:

insertViewNode in interface ViewNodeContainer

Parameters:

node - the node to add to this node

viewIndex - the initial index at which to insert the node

insertSiblingNodes

public void insertSiblingNodes(java.util.List<BeanNode<?>> nodes)

Insert the specified view nodes immediately above this node

Specified by:

insertSiblingNodes in interface ViewNodeContainer

Parameters:

nodes - the nodes to add to this node

moveDownNodes

public void moveDownNodes(java.util.List<BeanNode<?>> nodes)

Move the specified nodes down

Specified by:

moveDownNodes in interface ViewNodeContainer

moveUpNodes

public void moveUpNodes(java.util.List<BeanNode<?>> nodes)

Move the specified nodes up

Specified by:

moveUpNodes in interface ViewNodeContainer

removeNode

public void removeNode(BeanNode<?> node)

Remove the view node from this container

Specified by:

removeNode in interface ViewNodeContainer

Parameters:

node - the node to remove

removeNodes

public void removeNodes(java.util.List<BeanNode<?>> nodes)

Remove the view nodes from this container

Specified by:

removeNodes in interface ViewNodeContainer

Parameters:

nodes - the nodes to remove

getBorderNode

protected BorderNode getBorderNode()

get the border node

setBorderNode

protected void setBorderNode(BorderNode node)

set the border node

getWindow

public java.awt.Window getWindow()

get the containing or being the view

refreshDisplay

public void refreshDisplay()

refresh display

Overrides:

refreshDisplay in class BeanNode<java.awt.Component>

nodesAdded

public void nodesAdded(java.lang.Object source,
                       Brick container,
                       java.util.List<BeanNode<?>> nodes)

Handle the event in which nodes have been added to a container

Specified by:

nodesAdded in interface BrickListener

Parameters:

source - the source of the event

container - the node to which nodes have been added

nodes - the nodes which have been added

nodesRemoved

public void nodesRemoved(java.lang.Object source,
                         Brick container,
                         java.util.List<BeanNode<?>> nodes)

Handle the event in which nodes have been removed from a container

Specified by:

nodesRemoved in interface BrickListener

Parameters:

source - the source of the event

container - the node from which nodes have been removed

nodes - the nodes which have been removed

propertyChanged

public void propertyChanged(BeanNode<?> beanNode,
                            java.beans.PropertyDescriptor propertyDescriptor,
                            java.lang.Object value)

Handle the event in which a bean's property has been changed

Specified by:

propertyChanged in interface BrickListener

Parameters:

beanNode - the node whose property has changed

propertyDescriptor - the property which has changed

value - the new value

treeNeedsRefresh

public void treeNeedsRefresh(java.lang.Object source,
                             Brick brick)

Handle the event in which a brick's tree path needs refresh

Specified by:

treeNeedsRefresh in interface BrickListener

Parameters:

source - the source of the event

brick - the brick at which the refresh needs to be done

removeFromParent

public void removeFromParent()

Remove this brick from its parent

Specified by:

removeFromParent in class Brick

display

public void display()

Display the bean's window

Overrides:

display in class BeanNode<java.awt.Component>

dataLabel

public java.lang.String dataLabel()

Provides the name used to identify the class in an external data source.

Specified by:

dataLabel in interface DataListener

Specified by:

dataLabel in class BeanNode<java.awt.Component>

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

Overrides:

update in class BeanNode<java.awt.Component>

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

Overrides:

write in class BeanNode<java.awt.Component>

Parameters:

adaptor - The adaptor to which the receiver's data is written