uk.ac.kcl.cch.jb.pliny.parts
Class LinkableObjectPart

java.lang.Object
  org.eclipse.gef.editparts.AbstractEditPart
      org.eclipse.gef.editparts.AbstractGraphicalEditPart
          uk.ac.kcl.cch.jb.pliny.parts.OrderableAbstractGraphicalEditPart
              uk.ac.kcl.cch.jb.pliny.parts.LinkableObjectBasePart
                  uk.ac.kcl.cch.jb.pliny.parts.LinkableObjectPart

All Implemented Interfaces:

org.eclipse.gef.EditPart, EventListener, org.eclipse.gef.GraphicalEditPart, org.eclipse.core.runtime.IAdaptable, IButtonHolderPart, IDirectEditablePart, org.eclipse.gef.NodeEditPart, PropertyChangeListener, org.eclipse.gef.RequestConstants

Direct Known Subclasses:

ScalableLinkableObjectPart

public class LinkableObjectPart

extends LinkableObjectBasePart

implements IButtonHolderPart, IDirectEditablePart

extends LinkableObjectBasePart to support the display of reference objects in unscaleable reference areas.

This extends the functionally it inherits by adding:

• figure support for the reference object;
• edit policy support to allow for direct editing of the name of the reference object (NameDirectEditPolicy), or the passing of the request to the textual content;
• specifying model children either MapContentHolder or TextContentHolder depending upon whether the current state is to display the object's contents, or the object's own reference area;
• handling the toggling between map/content and minimized/expanded status
• handling the display of the referencer (model element ReferencerList) if requested; and
• supporting the user request to open the current reference object's surrogate in a full editor.

Author:

John Bradley

Nested Class Summary

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

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

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

org.eclipse.gef.editparts.AbstractEditPart.EditPolicyIterator

Field Summary

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

LinkableObjectPart(LinkableObject model)

Method Summary

protected void	createEditPolicies()
protected org.eclipse.draw2d.IFigure	createFigure()
org.eclipse.draw2d.IFigure	getContentPane()
BaseObject	getHeldObject() returns the BaseObject object that is the model for this editPart.
boolean	getMapStatus() returns the current reference/content display status of the edit part.
List	getModelChildren()
LinkableObjectFigure	getMyFigure()
String	getTextToEdit() requests the edit part to provide the text that is to be direct edited.
protected org.eclipse.draw2d.geometry.Rectangle	mapLocation(org.eclipse.draw2d.geometry.Rectangle r)
void	openFullEditor() requests the opening of the full editor for the surrogate of the LinkableOject associated with this GEF editpart.
void	performRequest(org.eclipse.gef.Request request)
void	refreshVisuals()
void	setColourFromType(LOType type)
void	setupText(org.eclipse.swt.widgets.Text text) allows the edit part to specify display attributes to be used while displaying the text for editing.
void	switchMapStatus() toggles reference/content display status of the edit part.
void	switchOpenStatus() toggles open/mininized status of the edit part.

Methods inherited from class uk.ac.kcl.cch.jb.pliny.parts.LinkableObjectBasePart

activate, deactivate, getLinkableObject, getModelSourceConnections, getModelTargetConnections, getMyType, getSourceConnectionAnchor, getSourceConnectionAnchor, getTargetConnectionAnchor, getTargetConnectionAnchor, propertyChange

Methods inherited from class uk.ac.kcl.cch.jb.pliny.parts.OrderableAbstractGraphicalEditPart

setSelected

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

addChildVisual, addNodeListener, addNotify, addSourceConnection, addTargetConnection, createConnection, createOrFindConnection, fireRemovingSourceConnection, fireRemovingTargetConnection, fireSourceConnectionAdded, fireTargetConnectionAdded, getAdapter, 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, getChildren, getCommand, getEditPolicy, getEditPolicyIterator, getEventListeners, getFlag, getModel, getParent, getRoot, getSelected, getTargetEditPart, getViewer, hasFocus, installEditPolicy, isActive, isSelectable, refreshChildren, register, registerAccessibility, registerModel, removeChild, removeEditPartListener, removeEditPolicy, setFlag, setFocus, setModel, setParent, showSourceFeedback, showTargetFeedback, toString, 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.GraphicalEditPart

addNodeListener, getFigure, getSourceConnections, getTargetConnections, removeNodeListener, setLayoutConstraint

Methods inherited from interface org.eclipse.gef.EditPart

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

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Constructor Detail

LinkableObjectPart

public LinkableObjectPart(LinkableObject model)

Method Detail

createFigure

protected org.eclipse.draw2d.IFigure createFigure()

Specified by:

createFigure in class LinkableObjectBasePart

getMyFigure

public LinkableObjectFigure getMyFigure()

createEditPolicies

protected void createEditPolicies()

Overrides:

createEditPolicies in class LinkableObjectBasePart

getModelChildren

public List getModelChildren()

getContentPane

public org.eclipse.draw2d.IFigure getContentPane()

Specified by:

getContentPane in interface org.eclipse.gef.GraphicalEditPart

switchOpenStatus

public void switchOpenStatus()

Description copied from interface: IButtonHolderPart

toggles open/mininized status of the edit part.

Specified by:

switchOpenStatus in interface IButtonHolderPart

switchMapStatus

public void switchMapStatus()

Description copied from interface: IButtonHolderPart

toggles reference/content display status of the edit part.

Specified by:

switchMapStatus in interface IButtonHolderPart

getMapStatus

public boolean getMapStatus()

Description copied from interface: IButtonHolderPart

returns the current reference/content display status of the edit part.

Specified by:

getMapStatus in interface IButtonHolderPart

Returns:

true if reference (map) display is currently set.

mapLocation

protected org.eclipse.draw2d.geometry.Rectangle mapLocation(org.eclipse.draw2d.geometry.Rectangle r)

refreshVisuals

public void refreshVisuals()

Specified by:

refreshVisuals in class LinkableObjectBasePart

openFullEditor

public void openFullEditor()

Description copied from interface: IButtonHolderPart

requests the opening of the full editor for the surrogate of the LinkableOject associated with this GEF editpart.

Specified by:

openFullEditor in interface IButtonHolderPart

getTextToEdit

public String getTextToEdit()

Description copied from interface: IDirectEditablePart

requests the edit part to provide the text that is to be direct edited.

Specified by:

getTextToEdit in interface IDirectEditablePart

Returns:

text to be edited.

setupText

public void setupText(org.eclipse.swt.widgets.Text text)

Description copied from interface: IDirectEditablePart

allows the edit part to specify display attributes to be used while displaying the text for editing. This usually involves specifying the colours to be used, and indicating whether the entire text should be initially selected or not.

Specified by:

setupText in interface IDirectEditablePart

Parameters:

text - org.eclipse.swt.widgets.Text to be used to manage the text editing.

performRequest

public void performRequest(org.eclipse.gef.Request request)

Specified by:

performRequest in interface org.eclipse.gef.EditPart

getHeldObject

public BaseObject getHeldObject()

Description copied from interface: IButtonHolderPart

returns the BaseObject object that is the model for this editPart.

Specified by:

getHeldObject in interface IButtonHolderPart

Returns:

BaseObject

setColourFromType

public void setColourFromType(LOType type)

Specified by:

setColourFromType in class LinkableObjectBasePart