Package org.eclipse.scanning.api.scan.ui

Class AbstractControl

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.scan.ui.AbstractControl

All Implemented Interfaces:

INameable, INamedNode

Direct Known Subclasses:

ControlEnumNode, ControlFileNode, ControlGroup, ControlNode, ControlTree

public abstract class AbstractControl
extends AbstractNameable
implements INamedNode

Constructor Summary

Constructors

Constructor	Description
AbstractControl()

Method Summary

Modifier and Type	Method	Description
void	add()
void	addChild(INamedNode child)
boolean	contains(String name)
boolean	containsChild(INamedNode iNameable)
boolean	equals(Object obj)
<T extends INamedNode> T	findChild(String name)
INamedNode[]	getChildren()
String	getDisplayName()	Used to provide a label in the UI
String	getParentName()
boolean	hasChildren()
int	hashCode()
void	removeChild(INamedNode node)
void	setChildren(INamedNode[] children)	Set the children.
void	setDisplayName(String displayName)
void	setParentName(String pName)
IPosition	toPosition()
IPosition	toPosition(IScannableDeviceService cservice)
String	toString()

Methods inherited from class org.eclipse.scanning.api.AbstractNameable

getName, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.INameable

getName, setName

Constructor Details

AbstractControl

public AbstractControl()

Method Details

add

public void add()

getParentName

public String getParentName()

Specified by:

getParentName in interface INamedNode

Returns:

setParentName

public void setParentName(String pName)

Specified by:

setParentName in interface INamedNode

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface INamedNode

Returns:

true if there are children.

getChildren

public INamedNode[] getChildren()

Specified by:

getChildren in interface INamedNode

Returns:

the children or null if there are none.

setChildren

public void setChildren(INamedNode[] children)

Description copied from interface: INamedNode

Set the children.

Specified by:

setChildren in interface INamedNode

Parameters:

children -

getDisplayName

public String getDisplayName()

Description copied from interface: INamedNode

Used to provide a label in the UI

Specified by:

getDisplayName in interface INamedNode

setDisplayName

public void setDisplayName(String displayName)

Specified by:

setDisplayName in interface INamedNode

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNameable

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractNameable

toString

public String toString()

Overrides:

toString in class AbstractNameable

addChild

public void addChild(INamedNode child)

removeChild

public void removeChild(INamedNode node)

containsChild

public boolean containsChild(INamedNode iNameable)

toPosition

public IPosition toPosition()

Returns:

toPosition

public IPosition toPosition(IScannableDeviceService cservice)

Parameters:

If - the value of any devices is null and they have a name, their values will be defaulted to the current IScannable.getPosition() value.

Returns:

contains

public boolean contains(String name)

findChild

public <T extends INamedNode> T findChild(String name)