Package org.csstudio.opibuilder.widgets.model

Class LinkingContainerModel

java.lang.Object

org.csstudio.opibuilder.model.AbstractWidgetModel

org.csstudio.opibuilder.model.AbstractContainerModel

org.csstudio.opibuilder.model.AbstractLinkingContainerModel

org.csstudio.opibuilder.widgets.model.LinkingContainerModel

All Implemented Interfaces:

IAdaptable, IPropertySource

public class LinkingContainerModel
extends AbstractLinkingContainerModel

The model for linking container widget.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LinkingContainerModel.ResizeBehaviour	How should the container behave when the OPI it is wrapping has content of a different size to the widget.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The ID of this widget model.
static final String	PROP_AUTO_SIZE	Deprecated.
static final String	PROP_OPI_FILE	The ID of the resource property.
static final String	PROP_RESIZE_BEHAVIOUR	How the widget should behave when the contents is not the same size as the widget.
static final String	PROP_ZOOMTOFITALL	Deprecated.
static final org.osgi.framework.Version	VERSION_CHANGE_OF_RESIZE_BEHAVIOUR	Versions before this didn't have an updated resize behaviour.

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

PROP_GROUP_NAME

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

PROP_CHILDREN, PROP_MACROS, 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
LinkingContainerModel()

Method Summary

Modifier and Type	Method	Description
protected void	configureProperties()	Configure the properties of the widget.
org.eclipse.draw2d.geometry.Dimension	getOriginSize()
String	getTypeID()
boolean	isAutoFit()	Returns the auto zoom state.
boolean	isAutoSize()
boolean	isChildrenOperationAllowable()	This is a flag to show if children operation edit policies should be installed.
boolean	isShowScrollBars()
void	processVersionDifference(org.osgi.framework.Version boyVersionOnFile)	Make necessary adjustment for widget compatibility between different versions.
void	scale(double widthRatio, double heightRatio)	Scale location and size of the widget.
void	scaleChildren()	Scale its children.
void	setChildrenGeoSize(org.eclipse.draw2d.geometry.Dimension childrenGeoSize)
void	setPropertyValue(Object id, Object value)

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

configureBaseProperties, getDisplayModel, getGroupName, getOPIFilePath, setDisplayModel, setDisplayModelDisplayID, setDisplayModelExecutionMode, setDisplayModelOpiRuntime, setDisplayModelViewer, setOPIFilePath

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

addChild, addChild, addChild, addChildren, addMacro, changeChildOrder, getAllDescendants, getChildByName, getChildren, getChildrenProperty, getEditPart, getIndexOf, getLayoutWidget, getMacroMap, getMacrosInput, getParentMacroMap, getSelectionProperty, removeAllChildren, removeChild, selectWidget, selectWidgets, setMacroMap

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

addConnection, addProperty, addProperty, addPVProperty, 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, getParent, getProperty, getPropertyDescriptors, getPropertyValue, getPVMap, getRawPropertyValue, getRawTooltip, getRGBFromColorProperty, getRootDisplayModel, getRootDisplayModel, getRulesInput, getRuntimePropertyList, getScaledSize, getScaleOptions, getScriptsInput, getSize, getSourceConnections, getSWTColorFromColorProperty, getTargetConnections, getTooltip, getType, getVersion, getVersionOnFile, getWidgetType, getWidth, getWUID, getX, getY, isEnabled, isPropertySet, isVisible, removeProperty, removePVProperty, resetPropertyValue, rotate90, rotate90, scaleConnections, setBackgroundColor, setBorderColor, setBorderStyle, setBorderWidth, setBounds, setBounds, setEnabled, setExecutionMode, setForegroundColor, setHeight, setLocation, setLocation, setName, setParent, setPropertyDescription, 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

ID

public static final String ID

The ID of this widget model.

See Also:

• Constant Field Values

VERSION_CHANGE_OF_RESIZE_BEHAVIOUR

public static final org.osgi.framework.Version VERSION_CHANGE_OF_RESIZE_BEHAVIOUR

Versions before this didn't have an updated resize behaviour.

PROP_OPI_FILE

public static final String PROP_OPI_FILE

The ID of the resource property.

See Also:

• Constant Field Values

PROP_ZOOMTOFITALL

@Deprecated
public static final String PROP_ZOOMTOFITALL

Deprecated.

The ID of the auto zoom property.

See Also:

• Constant Field Values

PROP_AUTO_SIZE

@Deprecated
public static final String PROP_AUTO_SIZE

Deprecated.

The ID of the auto scale property.

See Also:

• Constant Field Values

PROP_RESIZE_BEHAVIOUR

public static final String PROP_RESIZE_BEHAVIOUR

How the widget should behave when the contents is not the same size as the widget.

See Also:

• Constant Field Values

Constructor Details

LinkingContainerModel

public LinkingContainerModel()

Method Details

configureProperties

protected void configureProperties()

Description copied from class: AbstractWidgetModel

Configure the properties of the widget. Subclass should add new properties in this method.

Specified by:

configureProperties in class AbstractWidgetModel

setPropertyValue

public void setPropertyValue(Object id,
 Object value)

Specified by:

setPropertyValue in interface IPropertySource

Overrides:

setPropertyValue in class AbstractWidgetModel

getTypeID

public String getTypeID()

Specified by:

getTypeID in class AbstractWidgetModel

Returns:

the unique typeID of the model.

isAutoFit

public boolean isAutoFit()

Returns the auto zoom state.

Returns:

the auto zoom state

isAutoSize

public boolean isAutoSize()

isShowScrollBars

public boolean isShowScrollBars()

isChildrenOperationAllowable

public boolean isChildrenOperationAllowable()

Description copied from class: AbstractContainerModel

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

Overrides:

isChildrenOperationAllowable in class AbstractContainerModel

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 AbstractContainerModel

Parameters:

widthRatio - Ratio of width change.

heightRatio - Ratio of height change.

processVersionDifference

public void processVersionDifference(org.osgi.framework.Version boyVersionOnFile)

Description copied from class: AbstractWidgetModel

Make necessary adjustment for widget compatibility between different versions.

Overrides:

processVersionDifference in class AbstractWidgetModel

scaleChildren

public void scaleChildren()

Scale its children.

Overrides:

scaleChildren in class AbstractContainerModel

getOriginSize

public org.eclipse.draw2d.geometry.Dimension getOriginSize()

Overrides:

getOriginSize in class AbstractWidgetModel

Returns:

the original size before scaling

setChildrenGeoSize

public void setChildrenGeoSize(org.eclipse.draw2d.geometry.Dimension childrenGeoSize)