Package org.csstudio.opibuilder.editparts

Class AbstractPVWidgetEditPart

java.lang.Object

org.eclipse.gef.editparts.AbstractEditPart

org.eclipse.gef.editparts.AbstractGraphicalEditPart

org.csstudio.opibuilder.editparts.AbstractBaseEditPart

org.csstudio.opibuilder.editparts.AbstractPVWidgetEditPart

All Implemented Interfaces:

IPVWidgetEditpart, IAdaptable, org.eclipse.gef.EditPart, org.eclipse.gef.GraphicalEditPart, org.eclipse.gef.NodeEditPart, org.eclipse.gef.RequestConstants

Direct Known Subclasses:

AbstractBoolEditPart, AbstractChoiceEditPart, AbstractScaledWidgetEditPart, AbstractShapeEditPart, ActionButtonEditPart, ByteMonitorEditPart, CheckBoxEditPart, ComboEditPart, IntensityGraphEditPart, MenuButtonEditPart, NativeButtonEditPart, ScrollbarEditPart, SpinnerEditpart, TextUpdateEditPart, ThumbWheelEditPart, XYGraphEditPart

public abstract class AbstractPVWidgetEditPart
extends AbstractBaseEditPart
implements IPVWidgetEditpart

The abstract edit part for all PV armed widgets. Widgets inheritate this class will have the CSS context menu on it.

Nested Class Summary

Nested classes/interfaces inherited from class org.csstudio.opibuilder.editparts.AbstractBaseEditPart

AbstractBaseEditPart.BaseEditPartActionFilter

Nested classes/interfaces inherited from class org.eclipse.gef.editparts.AbstractGraphicalEditPart

org.eclipse.gef.editparts.AbstractGraphicalEditPart.AccessibleGraphicalEditPart, org.eclipse.gef.editparts.AbstractGraphicalEditPart.DefaultAccessibleAnchorProvider

Nested classes/interfaces inherited from class org.eclipse.gef.editparts.AbstractEditPart

org.eclipse.gef.editparts.AbstractEditPart.EditPolicyIterator

Nested classes/interfaces inherited from interface org.csstudio.opibuilder.editparts.IPVWidgetEditpart

IPVWidgetEditpart.ISetPVValueListener

Field Summary

Fields

Modifier and Type	Field	Description
protected PVWidgetEditpartDelegate	delegate

Fields inherited from class org.csstudio.opibuilder.editparts.AbstractBaseEditPart

anchorMap, propertyListenerMap

Fields inherited from class org.eclipse.gef.editparts.AbstractGraphicalEditPart

figure, sourceConnections, targetConnections

Fields inherited from class org.eclipse.gef.editparts.AbstractEditPart

children, FLAG_ACTIVE, FLAG_FOCUS, MAX_FLAG

Fields inherited from interface org.eclipse.gef.EditPart

SELECTED, SELECTED_NONE, SELECTED_PRIMARY

Fields inherited from interface org.eclipse.gef.RequestConstants

REQ_ADD, REQ_ALIGN, REQ_ALIGN_CHILDREN, REQ_CLONE, REQ_CONNECTION_END, REQ_CONNECTION_START, REQ_CREATE, REQ_CREATE_BENDPOINT, REQ_DELETE, REQ_DELETE_DEPENDANT, REQ_DIRECT_EDIT, REQ_MOVE, REQ_MOVE_BENDPOINT, REQ_MOVE_CHILDREN, REQ_OPEN, REQ_ORPHAN, REQ_ORPHAN_CHILDREN, REQ_RECONNECT_SOURCE, REQ_RECONNECT_TARGET, REQ_RESIZE, REQ_RESIZE_CHILDREN, REQ_SELECTION, REQ_SELECTION_HOVER

Constructor Summary

Constructors

Constructor	Description
AbstractPVWidgetEditPart()

Method Summary

Modifier and Type	Method	Description
void	activate()
void	addSetPVValueListener(IPVWidgetEditpart.ISetPVValueListener listener)
org.eclipse.draw2d.Border	calculateBorder()	Calculate the border for the widget with assume that the widget is connected.
protected ConnectionHandler	createConnectionHandler()
protected void	createEditPolicies()
protected void	doActivate()	Subclass should do the activate things in this method.
protected void	doDeActivate()	Subclass should do the deActivate things in this method.
Object	getAdapter(Class key)
String[]	getAllPVNames()
IPV	getControlPV()
IPV	getPV()	Get the PV corresponding to the PV Name property.
IPV	getPV(String pvPropId)	Get the pv by PV property id.
String	getPVName()
VType	getPVValue(String pvPropId)	Get value from one of the attached PVs.
PVWidgetEditpartDelegate	getPVWidgetEditpartDelegate()
protected void	initFigure(org.eclipse.draw2d.IFigure figure)	initialize the figure
boolean	isPVControlWidget()
protected void	markAsControlPV(String pvPropId, String pvValuePropId)	For PV Control widgets, mark this PV as control PV.
protected void	registerBasePropertyChangeHandlers()
void	setControlEnabled(boolean enabled)	Set whether the editpart is enabled for control.
void	setIgnoreOldPVValue(boolean ignoreOldValue)
void	setPVValue(String pvPropId, Object value)	Set PV to given value.

Methods inherited from class org.csstudio.opibuilder.editparts.AbstractBaseEditPart

addToConnectionHandler, createFigure, deactivate, doCreateFigure, doRefreshVisuals, executeAction, fillAnchorMap, getAllPVs, getAnchorMap, getClosestAnchorAt, getConnectionHandler, getDisplayDisposeListener, getExecutionMode, getExternalObject, getHookedActions, getMacroValue, getModelSourceConnections, getModelTargetConnections, getName, getPropertyValue, getPVByName, getSite, getSourceConnectionAnchor, getSourceConnectionAnchor, getTargetConnectionAnchor, getTargetConnectionAnchor, getTerminalNameFromAnchor, getValue, getVar, getWidgetModel, hookMouseClickAction, isSelectable, refreshVisuals, registerPropertyChangeHandlers, removeAllPropertyChangeHandlers, removeFromConnectionHandler, setEnabled, setExecutionMode, setExternalObject, setFigureBorder, setHeight, setPropertyChangeHandler, setPropertyValue, setPropertyValue, setSelectable, setSite, setValue, setValueInUIThread, setVar, setVisible, setWidth, setX, setY, toString

Methods inherited from class org.eclipse.gef.editparts.AbstractGraphicalEditPart

addChildVisual, addNodeListener, addNotify, addSourceConnection, addTargetConnection, createConnection, createOrFindConnection, fireRemovingSourceConnection, fireRemovingTargetConnection, fireSourceConnectionAdded, fireTargetConnectionAdded, getChildren, getContentPane, getDragTracker, getFigure, getLayer, getSourceConnections, getTargetConnections, primAddSourceConnection, primAddTargetConnection, primRemoveSourceConnection, primRemoveTargetConnection, refresh, refreshSourceConnections, refreshTargetConnections, registerVisuals, removeChildVisual, removeNodeListener, removeNotify, removeSourceConnection, removeTargetConnection, reorderChild, reorderSourceConnection, reorderTargetConnection, setFigure, setLayoutConstraint, unregisterVisuals

Methods inherited from class org.eclipse.gef.editparts.AbstractEditPart

activateEditPolicies, addChild, addEditPartListener, createChild, deactivateEditPolicies, debug, debugFeedback, eraseSourceFeedback, eraseTargetFeedback, fireActivated, fireChildAdded, fireDeactivated, fireRemovingChild, fireSelectionChanged, getAccessibleEditPart, getCommand, getEditPolicy, getEditPolicyIterable, getEditPolicyIterator, getEventListeners, getEventListenersIterable, getFlag, getModel, getModelChildren, getParent, getRoot, getSelected, getTargetEditPart, getViewer, hasFocus, installEditPolicy, isActive, performRequest, refreshChildren, register, registerAccessibility, registerModel, removeChild, removeEditPartListener, removeEditPolicy, setFlag, setFocus, setModel, setParent, setSelected, showSourceFeedback, showTargetFeedback, understandsRequest, unregister, unregisterAccessibility, unregisterModel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.gef.EditPart

addEditPartListener, addNotify, eraseSourceFeedback, eraseTargetFeedback, getCommand, getDragTracker, getEditPolicy, getModel, getParent, getRoot, getSelected, getTargetEditPart, getViewer, hasFocus, installEditPolicy, isActive, performRequest, refresh, removeEditPartListener, removeEditPolicy, removeNotify, setFocus, setModel, setParent, setSelected, showSourceFeedback, showTargetFeedback, understandsRequest

Methods inherited from interface org.eclipse.gef.GraphicalEditPart

addNodeListener, getChildren, getContentPane, getFigure, getSourceConnections, getTargetConnections, removeNodeListener, setLayoutConstraint

Field Details

delegate

protected PVWidgetEditpartDelegate delegate

Constructor Details

AbstractPVWidgetEditPart

public AbstractPVWidgetEditPart()

Method Details

doActivate

protected void doActivate()

Description copied from class: AbstractBaseEditPart

Subclass should do the activate things in this method. This method is last called from AbstractBaseEditPart.activate(). If there is code to be called as the first thing in AbstractBaseEditPart.activate(), it can be put in AbstractBaseEditPart.doCreateFigure().

Overrides:

doActivate in class AbstractBaseEditPart

activate

public void activate()

Specified by:

activate in interface org.eclipse.gef.EditPart

Overrides:

activate in class AbstractBaseEditPart

addSetPVValueListener

public void addSetPVValueListener(IPVWidgetEditpart.ISetPVValueListener listener)

Specified by:

addSetPVValueListener in interface IPVWidgetEditpart

calculateBorder

public org.eclipse.draw2d.Border calculateBorder()

Description copied from class: AbstractBaseEditPart

Calculate the border for the widget with assume that the widget is connected.

Overrides:

calculateBorder in class AbstractBaseEditPart

Returns:

the border.

createConnectionHandler

protected ConnectionHandler createConnectionHandler()

Overrides:

createConnectionHandler in class AbstractBaseEditPart

createEditPolicies

protected void createEditPolicies()

Overrides:

createEditPolicies in class AbstractBaseEditPart

doDeActivate

protected void doDeActivate()

Description copied from class: AbstractBaseEditPart

Subclass should do the deActivate things in this method. This is the first called in AbstractBaseEditPart.deactivate().

Overrides:

doDeActivate in class AbstractBaseEditPart

getAdapter

public Object getAdapter(Class key)

Specified by:

getAdapter in interface IAdaptable

Overrides:

getAdapter in class AbstractBaseEditPart

getAllPVNames

public String[] getAllPVNames()

Specified by:

getAllPVNames in interface IPVWidgetEditpart

Returns:

A String array with all PV names from PV properties.

getControlPV

public IPV getControlPV()

Specified by:

getControlPV in interface IPVWidgetEditpart

Returns:

the control PV. null if no control PV on this widget.

getPV

public IPV getPV()

Get the PV corresponding to the PV Name property. It is same as calling getPV("pv_name").

Specified by:

getPV in interface IPVWidgetEditpart

Returns:

the PV corresponding to the PV Name property. null if PV Name is not configured for this widget.

getPV

public IPV getPV(String pvPropId)

Get the pv by PV property id.

Specified by:

getPV in interface IPVWidgetEditpart

Parameters:

pvPropId - the PV property id.

Returns:

the corresponding pv for the pvPropId. null if the pv doesn't exist.

getPVWidgetEditpartDelegate

public PVWidgetEditpartDelegate getPVWidgetEditpartDelegate()

getPVName

public String getPVName()

Specified by:

getPVName in interface IPVWidgetEditpart

Returns:

the first PV name.

getPVValue

public VType getPVValue(String pvPropId)

Get value from one of the attached PVs.

Specified by:

getPVValue in interface IPVWidgetEditpart

Parameters:

pvPropId - the property id of the PV. It is "pv_name" for the main PV.

Returns:

the IValue of the PV.

initFigure

protected void initFigure(org.eclipse.draw2d.IFigure figure)

Description copied from class: AbstractBaseEditPart

initialize the figure

Overrides:

initFigure in class AbstractBaseEditPart

markAsControlPV

protected void markAsControlPV(String pvPropId,
 String pvValuePropId)

For PV Control widgets, mark this PV as control PV.

Parameters:

pvPropId - the propId of the PV.

registerBasePropertyChangeHandlers

protected void registerBasePropertyChangeHandlers()

Overrides:

registerBasePropertyChangeHandlers in class AbstractBaseEditPart

setIgnoreOldPVValue

public void setIgnoreOldPVValue(boolean ignoreOldValue)

setPVValue

public void setPVValue(String pvPropId,
 Object value)

Set PV to given value. Should accept Double, Double[], Integer, String, maybe more.

Specified by:

setPVValue in interface IPVWidgetEditpart

Parameters:

pvPropId -

value -

isPVControlWidget

public boolean isPVControlWidget()

Specified by:

isPVControlWidget in interface IPVWidgetEditpart

setControlEnabled

public void setControlEnabled(boolean enabled)

Set whether the editpart is enabled for control.

Specified by:

setControlEnabled in interface IPVWidgetEditpart