Package org.csstudio.opibuilder.model

Class AbstractContainerModel

java.lang.Object

org.csstudio.opibuilder.model.AbstractWidgetModel

org.csstudio.opibuilder.model.AbstractContainerModel

All Implemented Interfaces:

IAdaptable, IPropertySource

Direct Known Subclasses:

AbstractLinkingContainerModel, ArrayModel, DisplayModel, GroupingContainerModel, SashContainerModel, TabModel

public abstract class AbstractContainerModel
extends AbstractWidgetModel

The model which could contain children.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_CHILDREN
static final String	PROP_MACROS	Macros of the container, which will be available to its children.
static final String	PROP_SELECTION

Fields inherited from class org.csstudio.opibuilder.model.AbstractWidgetModel

PROP_ACTIONS, PROP_BORDER_COLOR, PROP_BORDER_STYLE, PROP_BORDER_WIDTH, PROP_COLOR_BACKGROUND, PROP_COLOR_FOREGROUND, PROP_ENABLED, PROP_FONT, PROP_HEIGHT, PROP_NAME, PROP_RULES, PROP_SCALE_OPTIONS, PROP_SCRIPTS, PROP_SRC_CONNECTIONS, PROP_TGT_CONNECTIONS, PROP_TOOLTIP, PROP_VISIBLE, PROP_WIDGET_TYPE, PROP_WIDGET_UID, PROP_WIDTH, PROP_XPOS, PROP_YPOS, VERSION

Constructor Summary

Constructors

Constructor	Description
AbstractContainerModel()

Method Summary

Modifier and Type	Method	Description
void	addChild(int index, AbstractWidgetModel child)
void	addChild(AbstractWidgetModel child)
void	addChild(AbstractWidgetModel child, boolean changeParent)	add child to the end of the children list.
void	addChildren(List<AbstractWidgetModel> children, boolean changeParent)
void	addMacro(String macroName, String macroValue)	Add a macro to the container.
void	changeChildOrder(AbstractWidgetModel child, int newIndex)	Change the order of the child.
protected void	configureBaseProperties()
List<AbstractWidgetModel>	getAllDescendants()
AbstractWidgetModel	getChildByName(String name)
List<AbstractWidgetModel>	getChildren()
AbstractWidgetProperty	getChildrenProperty()
AbstractContainerEditpart	getEditPart()
final int	getIndexOf(AbstractWidgetModel widget)
AbstractLayoutModel	getLayoutWidget()
LinkedHashMap<String,String>	getMacroMap()
MacrosInput	getMacrosInput()
LinkedHashMap<String,String>	getParentMacroMap()
AbstractWidgetProperty	getSelectionProperty()
boolean	isChildrenOperationAllowable()	This is a flag to show if children operation edit policies should be installed.
void	removeAllChildren()
void	removeChild(AbstractWidgetModel child)
void	scale(double widthRatio, double heightRatio)	Scale location and size of the widget.
void	scaleChildren()
void	selectWidget(AbstractWidgetModel newWidget, boolean append)
void	selectWidgets(List<AbstractWidgetModel> widgets, boolean append)
void	setMacroMap(LinkedHashMap<String,String> macroMap)	Set macro map of macro.

Methods inherited from class org.csstudio.opibuilder.model.AbstractWidgetModel

addConnection, addProperty, addProperty, addPVProperty, configureProperties, doScale, flipHorizontally, flipHorizontally, flipVertically, flipVertically, generateNewWUID, getActionsInput, getAdapter, getAllPropertyIDs, getBackgroundColor, getBorderColor, getBorderStyle, getBorderWidth, getBounds, getCastedPropertyValue, getEditableValue, getExecutionMode, getFont, getForegroundColor, getHeight, getIndex, getLocation, getName, getNestedDepth, getOriginLocation, getOriginSize, getParent, getProperty, getPropertyDescriptors, getPropertyValue, getPVMap, getRawPropertyValue, getRawTooltip, getRGBFromColorProperty, getRootDisplayModel, getRootDisplayModel, getRulesInput, getRuntimePropertyList, getScaledSize, getScaleOptions, getScriptsInput, getSize, getSourceConnections, getSWTColorFromColorProperty, getTargetConnections, getTooltip, getType, getTypeID, getVersion, getVersionOnFile, getWidgetType, getWidth, getWUID, getX, getY, isEnabled, isPropertySet, isVisible, processVersionDifference, removeProperty, removePVProperty, resetPropertyValue, rotate90, rotate90, scaleConnections, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setBounds, setBounds, setEnabled, setExecutionMode, setForegroundColor, setHeight, setLocation, setLocation, setName, setParent, setPropertyDescription, setPropertyValue, setPropertyValue, setPropertyVisible, setPropertyVisibleAndSavable, setScaleOptions, setSize, setSize, setTooltip, setVersionOnFile, setWidth, setX, setY

Methods inherited from class java.lang.Object

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

Field Details

PROP_CHILDREN

public static final String PROP_CHILDREN

See Also:

• Constant Field Values

PROP_SELECTION

public static final String PROP_SELECTION

See Also:

• Constant Field Values

PROP_MACROS

public static final String PROP_MACROS

Macros of the container, which will be available to its children.

See Also:

• Constant Field Values

Constructor Details

AbstractContainerModel

public AbstractContainerModel()

Method Details

addChild

public void addChild(AbstractWidgetModel child,
 boolean changeParent)

add child to the end of the children list.

Parameters:

child - the widget to be added

changeParent - true if the widget's parent should be changed.

addChildren

public void addChildren(List<AbstractWidgetModel> children,
 boolean changeParent)

addChild

public void addChild(AbstractWidgetModel child)

addChild

public void addChild(int index,
 AbstractWidgetModel child)

getLayoutWidget

public AbstractLayoutModel getLayoutWidget()

removeChild

public void removeChild(AbstractWidgetModel child)

removeAllChildren

public void removeAllChildren()

configureBaseProperties

protected void configureBaseProperties()

Overrides:

configureBaseProperties in class AbstractWidgetModel

getChildren

public List<AbstractWidgetModel> getChildren()

getAllDescendants

public List<AbstractWidgetModel> getAllDescendants()

Returns:

all descendants of this container.

getChildByName

public AbstractWidgetModel getChildByName(String name)

getIndexOf

public final int getIndexOf(AbstractWidgetModel widget)

Parameters:

widget -

Returns:

the index of the widget in the children list, which is also the order of the widget in the display.

getChildrenProperty

public AbstractWidgetProperty getChildrenProperty()

changeChildOrder

public void changeChildOrder(AbstractWidgetModel child,
 int newIndex)

Change the order of the child.

Parameters:

child -

newIndex -

getSelectionProperty

public AbstractWidgetProperty getSelectionProperty()

selectWidgets

public void selectWidgets(List<AbstractWidgetModel> widgets,
 boolean append)

selectWidget

public void selectWidget(AbstractWidgetModel newWidget,
 boolean append)

setMacroMap

public void setMacroMap(LinkedHashMap<String,String> macroMap)

Set macro map of macro. Container keeps reference to the map, no copy.

Parameters:

macroMap - Map of macro name/value entries

getMacroMap

public LinkedHashMap<String,String> getMacroMap()

Returns:

Map of macro name/value entries

getMacrosInput

public MacrosInput getMacrosInput()

addMacro

public void addMacro(String macroName,
 String macroValue)

Add a macro to the container. This method must be called before this widget is activated.

Parameters:

macroName - name of the macro

macroValue - value of the macro

getParentMacroMap

public LinkedHashMap<String,String> getParentMacroMap()

Returns:

the macros of its parent.

isChildrenOperationAllowable

public boolean isChildrenOperationAllowable()

This is a flag to show if children operation edit policies should be installed.

Returns:

true if children operation allowable.

scale

public void scale(double widthRatio,
 double heightRatio)

Description copied from class: AbstractWidgetModel

Scale location and size of the widget. If the widget needs to change its scale behavior, it should override AbstractWidgetModel.doScale(double, double) instead of this method.

Overrides:

scale in class AbstractWidgetModel

Parameters:

widthRatio - Ratio of width change.

heightRatio - Ratio of height change.

scaleChildren

public void scaleChildren()

getEditPart

public AbstractContainerEditpart getEditPart()