xal.extension.bricks

Class RootBrick

java.lang.Object

xal.extension.bricks.Brick

xal.extension.bricks.RootBrick

All Implemented Interfaces:

BrickListener, ViewNodeContainer, DataListener

public class RootBrick
extends Brick
implements ViewNodeContainer, DataListener

root brick to which windows are added

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_LABEL data label

Fields inherited from class xal.extension.bricks.Brick

EVENT_PROXY, MESSAGE_CENTER, TREE_NODE

Constructor Summary

Constructors

Constructor and Description
RootBrick() Constructor

Method Summary

Modifier and Type	Method and Description
void	add(java.util.List<BeanProxy<?>> beanProxies) Add the views to this node
void	addNodes(java.util.List<BeanNode<?>> originalNodes) 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	disposeAllWindows() dispose of all windows
int	getTreeIndexOffsetFromViewIndex() Get the tree index offset from the view index
void	insertSiblingNodes(java.util.List<BeanNode<?>> originalNodes) Insert the view nodes in this node beginning at the specified index
void	insertSiblings(java.util.List<BeanProxy<?>> viewProxies) Insert the views in this node beginning at the specified index
void	insertViewNode(ViewNode node, int viewIndex) Insert the bean node in this node beginning at the specified index
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<?> node, java.beans.PropertyDescriptor propertyDescriptor, java.lang.Object value) Handle the event in which a bean's property has been changed
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
java.lang.String	toString() Get the label
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.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 final java.lang.String DATA_LABEL

data label

See Also:

Constant Field Values

Constructor Detail

RootBrick

public RootBrick()

Constructor

Method Detail

disposeAllWindows

public void disposeAllWindows()

dispose of all windows

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

toString

public java.lang.String toString()

Get the label

Overrides:

toString in class java.lang.Object

Returns:

the label for this brick

add

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

Add the views to this node

Specified by:

add 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

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

insertViewNode

public void insertViewNode(ViewNode node,
                           int viewIndex)

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

Specified by:

insertViewNode in interface ViewNodeContainer

Parameters:

node - the node to insert in this node

viewIndex - the initial index at which to begin inserting the nodes

insertSiblings

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

Insert the views in this node beginning at the specified index

Specified by:

insertSiblings in interface ViewNodeContainer

Parameters:

viewProxies - the views to add to this node

addNodes

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

Add the views nodes to this node

Specified by:

addNodes in interface ViewNodeContainer

Parameters:

originalNodes - the nodes to add to this node

insertSiblingNodes

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

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

Specified by:

insertSiblingNodes in interface ViewNodeContainer

Parameters:

originalNodes - the nodes to add to this node

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

removeFromParent

public void removeFromParent()

Remove this brick from its parent

Specified by:

removeFromParent in class Brick

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

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

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<?> node,
                            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:

node - 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