uk.ac.kcl.cch.jb.pliny.figures
Class LinkableObjectFigure

java.lang.Object
  org.eclipse.draw2d.Figure
      uk.ac.kcl.cch.jb.pliny.figures.LinkableObjectFigure

All Implemented Interfaces:

org.eclipse.draw2d.IFigure

public class LinkableObjectFigure

extends org.eclipse.draw2d.Figure

Creates the draw2d Figure that represents the MVC View for LinkableObjects in a GEF generated reference/annotation area -- what the Pliny help pages calls the Reference Object.

The visual display has two areas -- a top title-bar like area which is implemented in the TopPanel area,.and a larger content area below it. Generally, the content area will be filled one of:

• a MapContentFigure (if the reference object is showing the surrogate's reference area),
• a TextContentFigure if it is showing the content text of a Note, or
• a figure (often a thumbnail image) provided by the surrogate that represents the surrogate itself pictorially.

This figure places a connectionlayer that GEF can use for placing connection objects between instances of this figure. This may be an artifact of an earlier design of this Figure and perhaps is not needed anymore.

Author:

John Bradley

Nested Class Summary

Nested classes inherited from class org.eclipse.draw2d.Figure

org.eclipse.draw2d.Figure.FigureIterator, org.eclipse.draw2d.Figure.IdentitySearch

Nested classes inherited from class org.eclipse.draw2d.IFigure

org.eclipse.draw2d.IFigure.NoInsets

Field Summary

static int	AREA_CONTENTS
protected boolean	isOpen
protected String	myName
static int	NO_CONTENTS
static int	TEXT_CONTENTS
protected TopPanel	topPanel

Fields inherited from class org.eclipse.draw2d.Figure

bgColor, border, bounds, fgColor, flags, font, MAX_FLAG, maxSize, minSize, NO_MANAGER, prefSize, toolTip

Fields inherited from interface org.eclipse.draw2d.IFigure

MAX_DIMENSION, MIN_DIMENSION, NO_INSETS

Constructor Summary

LinkableObjectFigure()

LinkableObjectFigure(String name, LinkableObjectPart myPart, org.eclipse.swt.graphics.Color foregroundColor, org.eclipse.swt.graphics.Color backgroundColor, boolean isOpen, boolean canSwitchOnMap, int contentType)

LinkableObjectFigure(String name, LinkableObjectPart myPart, org.eclipse.swt.graphics.Color foregroundColor, org.eclipse.swt.graphics.Color backgroundColor, boolean isOpen2, org.eclipse.draw2d.IFigure mainContents)

Method Summary

protected void	buildTheFigure()
org.eclipse.draw2d.IFigure	getContentsFigure()
org.eclipse.draw2d.ConnectionLayer	getMyConnectionLayer()
String	getName()
org.eclipse.draw2d.Label	getTitleLabel()
void	setColoursFromType(LOType type)
void	setContentType(int contentType)
void	setIsOpen(boolean isOpen)
void	setMapIcon()
void	setName(String name)
void	setReferencerIcon(boolean referencerOn)

Methods inherited from class org.eclipse.draw2d.Figure

add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findDescendantAtExcluding, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, findMouseEventTargetInDescendantsAt, fireCoordinateSystemChanged, fireFigureMoved, fireMoved, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, getLocalBackgroundColor, getLocalFont, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isMouseEventTarget, isOpaque, isRequestFocusEnabled, isShowing, isValid, isValidationRoot, isVisible, layout, paint, paintBorder, paintChildren, paintClientArea, paintFigure, primTranslate, remove, removeAll, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setChildrenDirection, setChildrenEnabled, setChildrenOrientation, setConstraint, setCursor, setEnabled, setFlag, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, useLocalCoordinates, validate

Methods inherited from class java.lang.Object

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

Field Detail

NO_CONTENTS

public static int NO_CONTENTS

TEXT_CONTENTS

public static int TEXT_CONTENTS

AREA_CONTENTS

public static int AREA_CONTENTS

topPanel

protected TopPanel topPanel

myName

protected String myName

isOpen

protected boolean isOpen

Constructor Detail

LinkableObjectFigure

public LinkableObjectFigure(String name,
                            LinkableObjectPart myPart,
                            org.eclipse.swt.graphics.Color foregroundColor,
                            org.eclipse.swt.graphics.Color backgroundColor,
                            boolean isOpen,
                            boolean canSwitchOnMap,
                            int contentType)

LinkableObjectFigure

public LinkableObjectFigure(String name,
                            LinkableObjectPart myPart,
                            org.eclipse.swt.graphics.Color foregroundColor,
                            org.eclipse.swt.graphics.Color backgroundColor,
                            boolean isOpen2,
                            org.eclipse.draw2d.IFigure mainContents)

LinkableObjectFigure

public LinkableObjectFigure()

Method Detail

getMyConnectionLayer

public org.eclipse.draw2d.ConnectionLayer getMyConnectionLayer()

buildTheFigure

protected void buildTheFigure()

getContentsFigure

public org.eclipse.draw2d.IFigure getContentsFigure()

getTitleLabel

public org.eclipse.draw2d.Label getTitleLabel()

setName

public void setName(String name)

getName

public String getName()

setReferencerIcon

public void setReferencerIcon(boolean referencerOn)

setIsOpen

public void setIsOpen(boolean isOpen)

setMapIcon

public void setMapIcon()

setContentType

public void setContentType(int contentType)

setColoursFromType

public void setColoursFromType(LOType type)