org.eclipse.gmf.gmfgraph
Interface Figure

All Superinterfaces:

EObject, FigureHandle, FigureMarker, Identity, Layoutable, Notifier

All Known Subinterfaces:

ConnectionFigure, CustomConnection, CustomDecoration, CustomFigure, DecorationFigure, Ellipse, Label, LabeledContainer, Polygon, PolygonDecoration, Polyline, PolylineConnection, PolylineDecoration, Rectangle, RoundedRectangle, Shape

All Known Implementing Classes:

CustomConnectionImpl, CustomDecorationImpl, CustomFigureImpl, EllipseImpl, LabeledContainerImpl, LabelImpl, PolygonDecorationImpl, PolygonImpl, PolylineConnectionImpl, PolylineDecorationImpl, PolylineImpl, RectangleImpl, RoundedRectangleImpl, ShapeImpl

public interface Figure

extends FigureMarker, FigureHandle, Identity

A representation of the model object 'Figure'. org.eclipse.draw2d.Figure

The following features are supported:

• Children
• Foreground Color
• Background Color
• Maximum Size
• Minimum Size
• Preferred Size
• Font
• Insets
• Border
• Location
• Size

See Also:

GMFGraphPackage.getFigure()

** Generated **

Model:

interface="true" abstract="true"

Method Summary

Color	getBackgroundColor() Returns the value of the 'Background Color' containment reference
Border	getBorder() Returns the value of the 'Border' containment reference
EList	getChildren() Returns the value of the 'Children' containment reference list.
Font	getFont() Returns the value of the 'Font' containment reference
Color	getForegroundColor() Returns the value of the 'Foreground Color' containment reference
Insets	getInsets() Returns the value of the 'Insets' containment reference
Point	getLocation() Returns the value of the 'Location' containment reference
Dimension	getMaximumSize() Returns the value of the 'Maximum Size' containment reference
Dimension	getMinimumSize() Returns the value of the 'Minimum Size' containment reference
Dimension	getPreferredSize() Returns the value of the 'Preferred Size' containment reference
Point	getSize() Returns the value of the 'Size' containment reference
void	setBackgroundColor(Color value) Sets the value of the 'Background Color' containment reference
void	setBorder(Border value) Sets the value of the 'Border' containment reference
void	setFont(Font value) Sets the value of the 'Font' containment reference
void	setForegroundColor(Color value) Sets the value of the 'Foreground Color' containment reference
void	setInsets(Insets value) Sets the value of the 'Insets' containment reference
void	setLocation(Point value) Sets the value of the 'Location' containment reference
void	setMaximumSize(Dimension value) Sets the value of the 'Maximum Size' containment reference
void	setMinimumSize(Dimension value) Sets the value of the 'Minimum Size' containment reference
void	setPreferredSize(Dimension value) Sets the value of the 'Preferred Size' containment reference
void	setSize(Point value) Sets the value of the 'Size' containment reference

Methods inherited from interface org.eclipse.gmf.gmfgraph.FigureMarker

getParent

Methods inherited from interface org.eclipse.gmf.gmfgraph.Layoutable

getLayout, getLayoutData, setLayout, setLayoutData

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface org.eclipse.gmf.gmfgraph.FigureHandle

getReferencingElements

Methods inherited from interface org.eclipse.gmf.gmfgraph.Identity

getName, setName

Method Detail

getChildren

public EList getChildren()

Returns the value of the 'Children' containment reference list. The list contents are of type FigureMarker. It is bidirectional and its opposite is 'Parent'.

If the meaning of the 'Children' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Children' containment reference list.

See Also:

GMFGraphPackage.getFigure_Children(), FigureMarker.getParent()

** Generated **

Model:

type="org.eclipse.gmf.gmfgraph.FigureMarker" opposite="parent" containment="true"

getForegroundColor

public Color getForegroundColor()

Returns the value of the 'Foreground Color' containment reference.

If the meaning of the 'Foreground Color' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Foreground Color' containment reference.

See Also:

Figure.setForegroundColor(Color), GMFGraphPackage.getFigure_ForegroundColor()

** Generated **

Model:

containment="true"

setForegroundColor

public void setForegroundColor(Color value)

Sets the value of the 'Foreground Color' containment reference.

Parameters:

value - the new value of the 'Foreground Color' containment reference.

See Also:

Figure.getForegroundColor()

** Generated **

getBackgroundColor

public Color getBackgroundColor()

Returns the value of the 'Background Color' containment reference.

If the meaning of the 'Background Color' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Background Color' containment reference.

See Also:

Figure.setBackgroundColor(Color), GMFGraphPackage.getFigure_BackgroundColor()

** Generated **

Model:

containment="true"

setBackgroundColor

public void setBackgroundColor(Color value)

Sets the value of the 'Background Color' containment reference.

Parameters:

value - the new value of the 'Background Color' containment reference.

See Also:

Figure.getBackgroundColor()

** Generated **

getMaximumSize

public Dimension getMaximumSize()

Returns the value of the 'Maximum Size' containment reference.

If the meaning of the 'Maximum Size' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Maximum Size' containment reference.

See Also:

Figure.setMaximumSize(Dimension), GMFGraphPackage.getFigure_MaximumSize()

** Generated **

Model:

containment="true"

setMaximumSize

public void setMaximumSize(Dimension value)

Sets the value of the 'Maximum Size' containment reference.

Parameters:

value - the new value of the 'Maximum Size' containment reference.

See Also:

Figure.getMaximumSize()

** Generated **

getMinimumSize

public Dimension getMinimumSize()

Returns the value of the 'Minimum Size' containment reference.

If the meaning of the 'Minimum Size' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Minimum Size' containment reference.

See Also:

Figure.setMinimumSize(Dimension), GMFGraphPackage.getFigure_MinimumSize()

** Generated **

Model:

containment="true"

setMinimumSize

public void setMinimumSize(Dimension value)

Sets the value of the 'Minimum Size' containment reference.

Parameters:

value - the new value of the 'Minimum Size' containment reference.

See Also:

Figure.getMinimumSize()

** Generated **

getPreferredSize

public Dimension getPreferredSize()

Returns the value of the 'Preferred Size' containment reference.

If the meaning of the 'Preferred Size' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Preferred Size' containment reference.

See Also:

Figure.setPreferredSize(Dimension), GMFGraphPackage.getFigure_PreferredSize()

** Generated **

Model:

containment="true"

setPreferredSize

public void setPreferredSize(Dimension value)

Sets the value of the 'Preferred Size' containment reference.

Parameters:

value - the new value of the 'Preferred Size' containment reference.

See Also:

Figure.getPreferredSize()

** Generated **

getFont

public Font getFont()

Returns the value of the 'Font' containment reference.

If the meaning of the 'Font' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Font' containment reference.

See Also:

Figure.setFont(Font), GMFGraphPackage.getFigure_Font()

** Generated **

Model:

containment="true"

setFont

public void setFont(Font value)

Sets the value of the 'Font' containment reference.

Parameters:

value - the new value of the 'Font' containment reference.

See Also:

Figure.getFont()

** Generated **

getInsets

public Insets getInsets()

Returns the value of the 'Insets' containment reference.

If the meaning of the 'Insets' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Insets' containment reference.

See Also:

Figure.setInsets(Insets), GMFGraphPackage.getFigure_Insets()

** Generated **

Model:

containment="true"

setInsets

public void setInsets(Insets value)

Sets the value of the 'Insets' containment reference.

Parameters:

value - the new value of the 'Insets' containment reference.

See Also:

Figure.getInsets()

** Generated **

getBorder

public Border getBorder()

Returns the value of the 'Border' containment reference.

If the meaning of the 'Border' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Border' containment reference.

See Also:

Figure.setBorder(Border), GMFGraphPackage.getFigure_Border()

** Generated **

Model:

containment="true"

setBorder

public void setBorder(Border value)

Sets the value of the 'Border' containment reference.

Parameters:

value - the new value of the 'Border' containment reference.

See Also:

Figure.getBorder()

** Generated **

getLocation

public Point getLocation()

Returns the value of the 'Location' containment reference.

If the meaning of the 'Location' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Location' containment reference.

See Also:

Figure.setLocation(Point), GMFGraphPackage.getFigure_Location()

** Generated **

Model:

containment="true"

setLocation

public void setLocation(Point value)

Sets the value of the 'Location' containment reference.

Parameters:

value - the new value of the 'Location' containment reference.

See Also:

Figure.getLocation()

** Generated **

getSize

public Point getSize()

Returns the value of the 'Size' containment reference.

If the meaning of the 'Size' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Size' containment reference.

See Also:

Figure.setSize(Point), GMFGraphPackage.getFigure_Size()

** Generated **

Model:

containment="true"

setSize

public void setSize(Point value)

Sets the value of the 'Size' containment reference.

Parameters:

value - the new value of the 'Size' containment reference.

See Also:

Figure.getSize()

** Generated **