Eclipse GMF Guide (Galileo) - GenCompartment (Eclipse GMF Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Generation Framework

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.gmf.codegen.gmfgen
Interface GenCompartment

All Superinterfaces:: org.eclipse.emf.ecore.EObject, GenChildContainer, GenCommonBase, GenContainerBase, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:: GenCompartmentImpl

public interface GenCompartment
extends GenChildContainer
extends GenChildContainer

A representation of the model object ' Gen Compartment '. Child container within node. Compartment, iow.

The following features are supported:

See Also:: GMFGenPackage.getGenCompartment()
** Generated **
Model:

Field Summary

static java.lang.String CLASS_NAME_PREFIX


Fields inherited from interface org.eclipse.gmf.codegen.gmfgen. GenContainerBase

CANONICAL_EDIT_POLICY_SUFFIX

Fields inherited from interface org.eclipse.gmf.codegen.gmfgen. GenCommonBase

DEFAULT_CLASS_NAME_PREFIX, EDIT_PART_SUFFIX, ITEM_SEMANTIC_EDIT_POLICY_SUFFIX, NOTATION_VIEW_FACTORY_SUFFIX

Method Summary

GenDiagram getDiagram ()
          Returns the value of the ' Diagram ' container reference.

GenNode getNode ()
          Returns the value of the ' Node ' reference.

java.lang.String getTitle ()
          Returns the value of the ' Title ' attribute

boolean isCanCollapse ()
          Returns the value of the ' Can Collapse ' attribute.

boolean isHideIfEmpty ()
          Returns the value of the ' Hide If Empty ' attribute.

boolean isListLayout ()
          Returns the value of the ' List Layout ' attribute.

boolean isNeedsTitle ()
          Returns the value of the ' Needs Title ' attribute.

void setCanCollapse (boolean value)
          Sets the value of the ' Can Collapse' attribute

void setHideIfEmpty (boolean value)
          Sets the value of the ' Hide If Empty' attribute

void setListLayout (boolean value)
          Sets the value of the ' List Layout' attribute

void setNeedsTitle (boolean value)
          Sets the value of the ' Needs Title' attribute

void setNode ( GenNode value)
          Sets the value of the ' Node' reference

void setTitle (java.lang.String value)
          Sets the value of the ' Title' attribute

Methods inherited from interface org.eclipse.gmf.codegen.gmfgen. GenChildContainer

getChildNodes

Methods inherited from interface org.eclipse.gmf.codegen.gmfgen. GenContainerBase

getAssistantNodes, getCanonicalEditPolicyClassName, getCanonicalEditPolicyQualifiedClassName, getContainedNodes, needsCanonicalEditPolicy, setCanonicalEditPolicyClassName

Methods inherited from interface org.eclipse.gmf.codegen.gmfgen. GenCommonBase

getBehaviour, getBehaviour, getClassNamePrefix, getClassNameSuffux, getDiagramRunTimeClass, getEditPartClassName, getEditPartQualifiedClassName, getElementType, getItemSemanticEditPolicyClassName, getItemSemanticEditPolicyQualifiedClassName, getLayoutType, getNotationViewFactoryClassName, getNotationViewFactoryQualifiedClassName, getStyles, getUniqueIdentifier, getViewmap, getVisualID, isSansDomain, setDiagramRunTimeClass, setEditPartClassName, setElementType, setItemSemanticEditPolicyClassName, setNotationViewFactoryClassName, setViewmap, setVisualID

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

Field Detail

CLASS_NAME_PREFIX

static final java.lang.String CLASS_NAME_PREFIX

See Also:: Constant Field Values

Method Detail

getTitle

java.lang.String getTitle()

Returns the value of the ' Title ' attribute.

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

Returns:: the value of the 'Title' attribute.
See Also:: setTitle(String), GMFGenPackage.getGenCompartment_Title()
** Generated **
Model:

setTitle

void setTitle(java.lang.String value)

Sets the value of the ' Title' attribute.

Parameters:: value - the new value of the 'Title' attribute.
See Also:: getTitle()
** Generated **

isCanCollapse

boolean isCanCollapse()

Returns the value of the ' Can Collapse ' attribute. The default value is "true".

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

Returns:: the value of the 'Can Collapse' attribute.
See Also:: setCanCollapse(boolean), GMFGenPackage.getGenCompartment_CanCollapse()
** Generated **
Model:: default="true"

setCanCollapse

void setCanCollapse(boolean value)

Sets the value of the ' Can Collapse' attribute.

Parameters:: value - the new value of the 'Can Collapse' attribute.
See Also:: isCanCollapse()
** Generated **

isHideIfEmpty

boolean isHideIfEmpty()

Returns the value of the ' Hide If Empty ' attribute. The default value is "true".

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

Returns:: the value of the 'Hide If Empty' attribute.
See Also:: setHideIfEmpty(boolean), GMFGenPackage.getGenCompartment_HideIfEmpty()
** Generated **
Model:: default="true"

setHideIfEmpty

void setHideIfEmpty(boolean value)

Sets the value of the ' Hide If Empty' attribute.

Parameters:: value - the new value of the 'Hide If Empty' attribute.
See Also:: isHideIfEmpty()
** Generated **

isNeedsTitle

boolean isNeedsTitle()

Returns the value of the ' Needs Title ' attribute. The default value is "true".

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

Returns:: the value of the 'Needs Title' attribute.
See Also:: setNeedsTitle(boolean), GMFGenPackage.getGenCompartment_NeedsTitle()
** Generated **
Model:: default="true"

setNeedsTitle

void setNeedsTitle(boolean value)

Sets the value of the ' Needs Title' attribute.

Parameters:: value - the new value of the 'Needs Title' attribute.
See Also:: isNeedsTitle()
** Generated **

getDiagram


GenDiagram getDiagram()

Returns the value of the ' Diagram ' container reference. It is bidirectional and its opposite is ' Compartments'.

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

Specified by:: getDiagram in interface GenCommonBase

Returns:: the value of the 'Diagram' container reference.
See Also:: GMFGenPackage.getGenCompartment_Diagram(), GenDiagram.getCompartments()
** Generated **
Model:: opposite="compartments" resolveProxies="false" required="true" transient="false" changeable="false"

getNode


GenNode getNode()

Returns the value of the ' Node ' reference. It is bidirectional and its opposite is ' Compartments'.

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

Returns:: the value of the 'Node' reference.
See Also:: setNode(GenNode), GMFGenPackage.getGenCompartment_Node(), GenNode.getCompartments()
** Generated **
Model:: opposite="compartments" required="true"

setNode

void setNode(
GenNode value)

Sets the value of the ' Node' reference.

Parameters:: value - the new value of the 'Node' reference.
See Also:: getNode()
** Generated **

isListLayout

boolean isListLayout()

Returns the value of the ' List Layout ' attribute. The default value is "true".

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

Returns:: the value of the 'List Layout' attribute.
See Also:: setListLayout(boolean), GMFGenPackage.getGenCompartment_ListLayout()
** Generated **
Model:: default="true"

setListLayout

void setListLayout(boolean value)

Sets the value of the ' List Layout' attribute.

Parameters:: value - the new value of the 'List Layout' attribute.
See Also:: isListLayout()
** Generated **