xal.extension.bricks

Class ViewProxy<ViewType extends java.awt.Component>

java.lang.Object

xal.extension.bricks.BeanProxy<ViewType>

xal.extension.bricks.ViewProxy<ViewType>

All Implemented Interfaces:

DataListener

public abstract class ViewProxy<ViewType extends java.awt.Component>
extends BeanProxy<ViewType>

interface for providing view node behavior

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_LABEL data label
protected boolean	IS_CONTAINER indicates whether the component should accept components
protected boolean	MAKE_ICON indicates whether to display a prototype icon

Fields inherited from class xal.extension.bricks.BeanProxy

PROTOTYPE_CLASS

Constructor Summary

Constructors

Constructor and Description
ViewProxy(java.lang.Class<ViewType> prototypeClass, boolean isContainer, boolean makeIcon) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	dataLabel() Provides the name used to identify the class in an external data source.
java.awt.Container	getContainer(ViewType view) Get the container to which sub views should be added
javax.swing.Icon	getIcon() Get an icon representation for the view
java.awt.Image	getIconImage() Get an image representation for the view
static ViewProxy<?>	getInstance(DataAdaptor adaptor) generator
void	handleChildNodePropertyChange(ViewNode node, BeanNode<?> beanNode, java.beans.PropertyDescriptor propertyDescriptor, java.lang.Object value) handle child node property change
boolean	isContainer() Determine whether the view should be treated as a container
boolean	isWindow() determine if the view is a window

Methods inherited from class xal.extension.bricks.BeanProxy

getBeanInstance, getBeanInstance, getConstructorParameters, getConstructorParameterTypes, getJavaDeclarationSnippet, getJavaReferenceSnippet, getJythonReferenceSnippet, getName, getPrototype, getPrototypeClass, getReferenceSnippetFetchMethodArgumentsString, getReferenceSnippetFetchMethodName, getShortName, getText, getType, getXALReferenceSnippet, setup, setupPrototype, toString, update, write

Methods inherited from class java.lang.Object

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

Field Detail

DATA_LABEL

public static final java.lang.String DATA_LABEL

data label

See Also:

Constant Field Values

IS_CONTAINER

protected final boolean IS_CONTAINER

indicates whether the component should accept components

MAKE_ICON

protected final boolean MAKE_ICON

indicates whether to display a prototype icon

Constructor Detail

ViewProxy

public ViewProxy(java.lang.Class<ViewType> prototypeClass,
                 boolean isContainer,
                 boolean makeIcon)

Constructor

Method Detail

getInstance

public static ViewProxy<?> getInstance(DataAdaptor adaptor)

generator

isContainer

public boolean isContainer()

Determine whether the view should be treated as a container

isWindow

public boolean isWindow()

determine if the view is a window

getContainer

public java.awt.Container getContainer(ViewType view)

Get the container to which sub views should be added

Parameters:

view - the view whose container is to be gotten

Returns:

the view's container

handleChildNodePropertyChange

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

handle child node property change

getIcon

public javax.swing.Icon getIcon()

Get an icon representation for the view

Overrides:

getIcon in class BeanProxy<ViewType extends java.awt.Component>

getIconImage

public java.awt.Image getIconImage()

Get an image representation for the view

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 BeanProxy<ViewType extends java.awt.Component>

Returns:

a tag that identifies the receiver's type