Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.util.graph
Class CustomShapeFigure

java.lang.Object
  extended by org.eclipse.draw2d.Figure
      extended by org.eclipse.draw2d.Shape
          extended by eu.esdihumboldt.hale.ui.util.graph.CustomShapeFigure
All Implemented Interfaces:
org.eclipse.draw2d.IFigure, org.eclipse.zest.core.widgets.ILabeledFigure, org.eclipse.zest.core.widgets.IStyleableFigure
Direct Known Subclasses:
CustomShapeLabel, EntityFigure, FunctionFigure, ParameterFigure

public class CustomShapeFigure
extends org.eclipse.draw2d.Shape
implements org.eclipse.zest.core.widgets.IStyleableFigure, org.eclipse.zest.core.widgets.ILabeledFigure

A custom shaped figure for use in graphs.

Author:
Simon Templer

Nested Class Summary
static interface CustomShapeFigure.ShapePainter
          Paints fill and outline of a shape and provides corresponding insets.
 
Nested classes/interfaces inherited from class org.eclipse.draw2d.Figure
org.eclipse.draw2d.Figure.FigureIterator, org.eclipse.draw2d.Figure.IdentitySearch
 
Nested classes/interfaces inherited from interface org.eclipse.draw2d.IFigure
org.eclipse.draw2d.IFigure.NoInsets
 
Field Summary
protected  CustomShapeFigure.ShapePainter painter
          The shape painter used for the figure
 
Fields inherited from class org.eclipse.draw2d.Shape
lineStyle, lineWidth
 
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
CustomShapeFigure(CustomShapeFigure.ShapePainter painter)
          Create a custom shaped figure.
 
Method Summary
protected  void adjustSize()
          Adjust the figure size.
protected  void fillShape(org.eclipse.draw2d.Graphics graphics)
           
 org.eclipse.swt.graphics.Color getBorderColor()
          Get the border color
 org.eclipse.swt.graphics.Image getIcon()
           
 org.eclipse.draw2d.geometry.Insets getInsets()
           
 int getMaximumWidth()
          Get the maximum width (which is applied in getPreferredSize(int, int)).
 org.eclipse.draw2d.geometry.Dimension getPreferredSize(int wHint, int hHint)
           
 String getText()
           
protected  void outlineShape(org.eclipse.draw2d.Graphics graphics)
           
 void setBorderColor(org.eclipse.swt.graphics.Color borderColor)
           
 void setBorderWidth(int borderWidth)
           
 void setIcon(org.eclipse.swt.graphics.Image icon)
           
 void setIconLabel(org.eclipse.draw2d.Label iconLabel)
          Set the label that displays the icon.
 void setMaximumWidth(int maximumWidth)
          Set the maximum width (which is applied in getPreferredSize(int, int)).
 void setText(String text)
           
 void setTextLabel(org.eclipse.draw2d.Label textLabel)
          Set the label that displays the text.
 
Methods inherited from class org.eclipse.draw2d.Shape
getAlpha, getAntialias, getLineAttributes, getLineCap, getLineDash, getLineDashOffset, getLineJoin, getLineMiterLimit, getLineStyle, getLineWidth, getLineWidthFloat, paintFigure, setAlpha, setAlpha, setAntialias, setAntialias, setFill, setFillXOR, setLineAttributes, setLineCap, setLineDash, setLineDashOffset, setLineJoin, setLineMiterLimit, setLineStyle, setLineWidth, setLineWidthFloat, setOutline, setOutlineXOR, setXOR
 
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, getClippingStrategy, getCursor, getFlag, getFont, getForegroundColor, getLayoutManager, getListeners, getLocalBackgroundColor, getLocalFont, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, 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, 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, setClippingStrategy, 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
 
Methods inherited from interface org.eclipse.draw2d.IFigure
add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getClippingStrategy, getCursor, getFont, getForegroundColor, getLayoutManager, getLocalBackgroundColor, getLocalForegroundColor, getMaximumSize, getMinimumSize, getMinimumSize, getParent, 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, isOpaque, isRequestFocusEnabled, isShowing, isVisible, paint, remove, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setClippingStrategy, setConstraint, setCursor, setEnabled, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setLocation, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, validate
 

Field Detail

painter

protected final CustomShapeFigure.ShapePainter painter
The shape painter used for the figure

Constructor Detail

CustomShapeFigure

public CustomShapeFigure(CustomShapeFigure.ShapePainter painter)
Create a custom shaped figure.

Parameters:
painter - the painter drawing the figure shape
Method Detail

getPreferredSize

public org.eclipse.draw2d.geometry.Dimension getPreferredSize(int wHint,
                                                              int hHint)
Specified by:
getPreferredSize in interface org.eclipse.draw2d.IFigure
Overrides:
getPreferredSize in class org.eclipse.draw2d.Figure
See Also:
Figure.getPreferredSize(int, int)

getMaximumWidth

public int getMaximumWidth()
Get the maximum width (which is applied in getPreferredSize(int, int)).

Returns:
the maximum width, a negative value for no maximum width

setMaximumWidth

public void setMaximumWidth(int maximumWidth)
Set the maximum width (which is applied in getPreferredSize(int, int)).

Parameters:
maximumWidth - the maximum width to set, a negative value for no maximum width

setTextLabel

public void setTextLabel(org.eclipse.draw2d.Label textLabel)
Set the label that displays the text.

Parameters:
textLabel - the label to display the text, may be the same as the icon label or null to ignore the text
See Also:
setIconLabel(Label)

setIconLabel

public void setIconLabel(org.eclipse.draw2d.Label iconLabel)
Set the label that displays the icon.

Parameters:
iconLabel - the label to display the icon, may be the same as the text label or null to ignore the icon
See Also:
setTextLabel(Label)

getInsets

public org.eclipse.draw2d.geometry.Insets getInsets()
Specified by:
getInsets in interface org.eclipse.draw2d.IFigure
Overrides:
getInsets in class org.eclipse.draw2d.Figure

fillShape

protected void fillShape(org.eclipse.draw2d.Graphics graphics)
Specified by:
fillShape in class org.eclipse.draw2d.Shape

outlineShape

protected void outlineShape(org.eclipse.draw2d.Graphics graphics)
Specified by:
outlineShape in class org.eclipse.draw2d.Shape

adjustSize

protected void adjustSize()
Adjust the figure size. The default implementation sets the size to the preferred size.


getBorderColor

public org.eclipse.swt.graphics.Color getBorderColor()
Get the border color

Returns:
the border color, null if it was not set using setBorderColor(Color)

setBorderColor

public void setBorderColor(org.eclipse.swt.graphics.Color borderColor)
Specified by:
setBorderColor in interface org.eclipse.zest.core.widgets.IStyleableFigure

setBorderWidth

public void setBorderWidth(int borderWidth)
Specified by:
setBorderWidth in interface org.eclipse.zest.core.widgets.IStyleableFigure

setText

public void setText(String text)
Specified by:
setText in interface org.eclipse.zest.core.widgets.ILabeledFigure

getText

public String getText()
Specified by:
getText in interface org.eclipse.zest.core.widgets.ILabeledFigure

setIcon

public void setIcon(org.eclipse.swt.graphics.Image icon)
Specified by:
setIcon in interface org.eclipse.zest.core.widgets.ILabeledFigure

getIcon

public org.eclipse.swt.graphics.Image getIcon()
Specified by:
getIcon in interface org.eclipse.zest.core.widgets.ILabeledFigure

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d