org.eclipse.gmf.gmfgraph
Interface GridLayoutData

All Superinterfaces:

org.eclipse.emf.ecore.EObject, LayoutData, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

GridLayoutDataImpl

public interface GridLayoutData
extends LayoutData

A representation of the model object 'Grid Layout Data'.

The following features are supported:

• Grab Excess Horizontal Space
• Grab Excess Vertical Space
• Vertical Alignment
• Horizontal Alignment
• Vertical Span
• Horizontal Span
• Horizontal Indent
• Size Hint

See Also:

GMFGraphPackage.getGridLayoutData()

Method Summary

Alignment	getHorizontalAlignment() Returns the value of the 'Horizontal Alignment' attribute.
int	getHorizontalIndent() Returns the value of the 'Horizontal Indent' attribute.
int	getHorizontalSpan() Returns the value of the 'Horizontal Span' attribute.
Dimension	getSizeHint() Returns the value of the 'Size Hint' containment reference.
Alignment	getVerticalAlignment() Returns the value of the 'Vertical Alignment' attribute.
int	getVerticalSpan() Returns the value of the 'Vertical Span' attribute.
boolean	isGrabExcessHorizontalSpace() Returns the value of the 'Grab Excess Horizontal Space' attribute.
boolean	isGrabExcessVerticalSpace() Returns the value of the 'Grab Excess Vertical Space' attribute.
void	setGrabExcessHorizontalSpace(boolean value) Sets the value of the 'Grab Excess Horizontal Space' attribute.
void	setGrabExcessVerticalSpace(boolean value) Sets the value of the 'Grab Excess Vertical Space' attribute.
void	setHorizontalAlignment(Alignment value) Sets the value of the 'Horizontal Alignment' attribute.
void	setHorizontalIndent(int value) Sets the value of the 'Horizontal Indent' attribute.
void	setHorizontalSpan(int value) Sets the value of the 'Horizontal Span' attribute.
void	setSizeHint(Dimension value) Sets the value of the 'Size Hint' containment reference.
void	setVerticalAlignment(Alignment value) Sets the value of the 'Vertical Alignment' attribute.
void	setVerticalSpan(int value) Sets the value of the 'Vertical Span' attribute.

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

getOwner, setOwner

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

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

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

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

isGrabExcessHorizontalSpace

boolean isGrabExcessHorizontalSpace()

Returns the value of the 'Grab Excess Horizontal Space' attribute. The default value is "false".

If the meaning of the 'Grab Excess Horizontal Space' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Grab Excess Horizontal Space' attribute.

See Also:

setGrabExcessHorizontalSpace(boolean), GMFGraphPackage.getGridLayoutData_GrabExcessHorizontalSpace()

setGrabExcessHorizontalSpace

void setGrabExcessHorizontalSpace(boolean value)

Sets the value of the 'Grab Excess Horizontal Space' attribute.

Parameters:

value - the new value of the 'Grab Excess Horizontal Space' attribute.

See Also:

isGrabExcessHorizontalSpace()

isGrabExcessVerticalSpace

boolean isGrabExcessVerticalSpace()

Returns the value of the 'Grab Excess Vertical Space' attribute. The default value is "false".

If the meaning of the 'Grab Excess Vertical Space' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Grab Excess Vertical Space' attribute.

See Also:

setGrabExcessVerticalSpace(boolean), GMFGraphPackage.getGridLayoutData_GrabExcessVerticalSpace()

setGrabExcessVerticalSpace

void setGrabExcessVerticalSpace(boolean value)

Sets the value of the 'Grab Excess Vertical Space' attribute.

Parameters:

value - the new value of the 'Grab Excess Vertical Space' attribute.

See Also:

isGrabExcessVerticalSpace()

getVerticalAlignment

Alignment getVerticalAlignment()

Returns the value of the 'Vertical Alignment' attribute. The default value is "CENTER". The literals are from the enumeration Alignment.

If the meaning of the 'Vertical Alignment' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Vertical Alignment' attribute.

See Also:

Alignment, setVerticalAlignment(Alignment), GMFGraphPackage.getGridLayoutData_VerticalAlignment()

setVerticalAlignment

void setVerticalAlignment(Alignment value)

Sets the value of the 'Vertical Alignment' attribute.

Parameters:

value - the new value of the 'Vertical Alignment' attribute.

See Also:

Alignment, getVerticalAlignment()

getHorizontalAlignment

Alignment getHorizontalAlignment()

Returns the value of the 'Horizontal Alignment' attribute. The default value is "CENTER". The literals are from the enumeration Alignment.

If the meaning of the 'Horizontal Alignment' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Horizontal Alignment' attribute.

See Also:

Alignment, setHorizontalAlignment(Alignment), GMFGraphPackage.getGridLayoutData_HorizontalAlignment()

setHorizontalAlignment

void setHorizontalAlignment(Alignment value)

Sets the value of the 'Horizontal Alignment' attribute.

Parameters:

value - the new value of the 'Horizontal Alignment' attribute.

See Also:

Alignment, getHorizontalAlignment()

getVerticalSpan

int getVerticalSpan()

Returns the value of the 'Vertical Span' attribute. The default value is "1".

If the meaning of the 'Vertical Span' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Vertical Span' attribute.

See Also:

setVerticalSpan(int), GMFGraphPackage.getGridLayoutData_VerticalSpan()

setVerticalSpan

void setVerticalSpan(int value)

Sets the value of the 'Vertical Span' attribute.

Parameters:

value - the new value of the 'Vertical Span' attribute.

See Also:

getVerticalSpan()

getHorizontalSpan

int getHorizontalSpan()

Returns the value of the 'Horizontal Span' attribute. The default value is "1".

If the meaning of the 'Horizontal Span' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Horizontal Span' attribute.

See Also:

setHorizontalSpan(int), GMFGraphPackage.getGridLayoutData_HorizontalSpan()

setHorizontalSpan

void setHorizontalSpan(int value)

Sets the value of the 'Horizontal Span' attribute.

Parameters:

value - the new value of the 'Horizontal Span' attribute.

See Also:

getHorizontalSpan()

getHorizontalIndent

int getHorizontalIndent()

Returns the value of the 'Horizontal Indent' attribute.

If the meaning of the 'Horizontal Indent' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Horizontal Indent' attribute.

See Also:

setHorizontalIndent(int), GMFGraphPackage.getGridLayoutData_HorizontalIndent()

setHorizontalIndent

void setHorizontalIndent(int value)

Sets the value of the 'Horizontal Indent' attribute.

Parameters:

value - the new value of the 'Horizontal Indent' attribute.

See Also:

getHorizontalIndent()

getSizeHint

Dimension getSizeHint()

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

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

Returns:

the value of the 'Size Hint' containment reference.

See Also:

setSizeHint(Dimension), GMFGraphPackage.getGridLayoutData_SizeHint()

setSizeHint

void setSizeHint(Dimension value)

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

Parameters:

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

See Also:

getSizeHint()