de.cau.cs.kieler.kiml.graphiti
Class GraphitiLayoutConfig

java.lang.Object
  extended by de.cau.cs.kieler.kiml.DefaultLayoutConfig
      extended by de.cau.cs.kieler.kiml.ui.layout.EclipseLayoutConfig
          extended by de.cau.cs.kieler.kiml.graphiti.GraphitiLayoutConfig
All Implemented Interfaces:
IPropertyHolder, ILayoutConfig

public class GraphitiLayoutConfig
extends EclipseLayoutConfig

Layout option configuration for Graphiti.

Rating red

Field Summary
static String DIAG_PREFIX
          Prefix for diagram defaults stored in the top-level edit part.
static String PREFIX
          Prefix for all layout options.
 
Constructor Summary
GraphitiLayoutConfig()
          Creates a layout configuration for Graphiti.
GraphitiLayoutConfig(ILayoutConfig externalConfig)
          Creates a layout configuration for Graphiti using an external configuration.
 
Method Summary
protected  void addProperties(Map<IProperty<?>,Object> options)
          Add all notation model values to the given map of layout options.
 void clearProperties()
          Throws an UnsupportedOperationException, since this configuration cannot be used to change default values.
protected
<T> T
doGetProperty(LayoutOptionData<T> optionData)
          Retrieve the value that is stored in the notation model or the default value for a layout option.
<T> T
getDiagramDefault(LayoutOptionData<T> optionData)
          Returns the default value for the selected diagram.
 void initialize(org.eclipse.graphiti.ui.internal.parts.IPictogramElementEditPart editPart)
          Initialize the configuration for a graphical edit part.
 boolean isDefault(LayoutOptionData<?> optionData)
          Since this configuration handles only default values, this always returns true.
 void setDiagramDefault(LayoutOptionData<?> optionData, Object value)
          Throws an UnsupportedOperationException, since this configuration cannot be used to change default values.
 void setFocus(Object element)
          Set the focus of the layout configuration on a specific edit part.
 void setProperty(IProperty<?> property, Object value)
          Throws an UnsupportedOperationException, since this configuration cannot be used to change default values.
 
Methods inherited from class de.cau.cs.kieler.kiml.ui.layout.EclipseLayoutConfig
getAllProperties, getEditPart, getExternalConfig, getFixedSizeValue, getOption, getOption, getPortConstraintsValue, getProperty, initialize, setAspectRatio, setChildren, setPorts
 
Methods inherited from class de.cau.cs.kieler.kiml.DefaultLayoutConfig
copyProperties, getContainerLayouterData, getContentLayouterData, getLayouterData, getOptionData, initialize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PREFIX

public static final String PREFIX
Prefix for all layout options.

See Also:
Constant Field Values

DIAG_PREFIX

public static final String DIAG_PREFIX
Prefix for diagram defaults stored in the top-level edit part.

See Also:
Constant Field Values
Constructor Detail

GraphitiLayoutConfig

public GraphitiLayoutConfig()
Creates a layout configuration for Graphiti.


GraphitiLayoutConfig

public GraphitiLayoutConfig(ILayoutConfig externalConfig)
Creates a layout configuration for Graphiti using an external configuration.

Parameters:
externalConfig - an external layout configuration
Method Detail

setFocus

public void setFocus(Object element)
Set the focus of the layout configuration on a specific edit part. The domain model element of the edit part is passed to the super-class as well. This can be done without initializing the layout configuration in order to use EclipseLayoutConfig.getAllProperties() efficiently, since the same configuration instance can be reused multiple times.

Specified by:
setFocus in interface ILayoutConfig
Overrides:
setFocus in class EclipseLayoutConfig
Parameters:
element - an instance of IGraphicalEditPart

clearProperties

public void clearProperties()
Throws an UnsupportedOperationException, since this configuration cannot be used to change default values.

Specified by:
clearProperties in interface ILayoutConfig
Overrides:
clearProperties in class DefaultLayoutConfig

isDefault

public boolean isDefault(LayoutOptionData<?> optionData)
Since this configuration handles only default values, this always returns true.

Specified by:
isDefault in interface ILayoutConfig
Overrides:
isDefault in class DefaultLayoutConfig
Parameters:
optionData - layout option data
Returns:
true

setProperty

public void setProperty(IProperty<?> property,
                        Object value)
Throws an UnsupportedOperationException, since this configuration cannot be used to change default values.

Specified by:
setProperty in interface IPropertyHolder
Overrides:
setProperty in class DefaultLayoutConfig
Parameters:
property - a layout option
value - an option value

doGetProperty

protected <T> T doGetProperty(LayoutOptionData<T> optionData)
Retrieve the value that is stored in the notation model or the default value for a layout option.

Overrides:
doGetProperty in class EclipseLayoutConfig
Type Parameters:
T - type of option
Parameters:
optionData - a layout option
Returns:
the stored or default value for the layout option

initialize

public final void initialize(org.eclipse.graphiti.ui.internal.parts.IPictogramElementEditPart editPart)
Initialize the configuration for a graphical edit part.

Parameters:
editPart - an edit part

setDiagramDefault

public void setDiagramDefault(LayoutOptionData<?> optionData,
                              Object value)
Throws an UnsupportedOperationException, since this configuration cannot be used to change default values.

Specified by:
setDiagramDefault in interface ILayoutConfig
Overrides:
setDiagramDefault in class DefaultLayoutConfig
Parameters:
optionData - a layout option
value - an option value

getDiagramDefault

public <T> T getDiagramDefault(LayoutOptionData<T> optionData)
Returns the default value for the selected diagram.

Type Parameters:
T - type of option
Parameters:
optionData - layout option data
Returns:
the current diagram-default value, or null

addProperties

protected void addProperties(Map<IProperty<?>,Object> options)
Add all notation model values to the given map of layout options.

Overrides:
addProperties in class EclipseLayoutConfig
Parameters:
options - a map of layout option values