de.cau.cs.kieler.kiml.config
Interface ILayoutConfig

All Known Subinterfaces:
IMutableLayoutConfig
All Known Implementing Classes:
ActionLayoutConfig, AnnotationsLayoutConfig, AnnotationsLayoutConfig, CompoundLayoutConfig, DefaultLayoutConfig, EclipseLayoutConfig, GmfLayoutConfig, GraphitiLayoutConfig, HVLayoutConfig, HypernodeLayoutConfig, SemanticLayoutConfig, TypeLayoutConfig, VolatileLayoutConfig

public interface ILayoutConfig

Layout option configuration interface.

Rating proposed yellow
(2011-01-13) msp

Method Summary
 void enrich(LayoutContext context)
          Enrich the given context with additional information that can be derived from what is already contained.
 int getPriority()
          Return the priority of this layout configuration, which is relevant when multiple configurations are applied.
 Object getValue(LayoutOptionData<?> optionData, LayoutContext context)
          Get the current value for a layout option in the given context.
 void transferValues(KGraphData graphData, LayoutContext context)
          Transfer all non-default values that are managed by this layout configuration to the given graph data holder.
 

Method Detail

getPriority

int getPriority()
Return the priority of this layout configuration, which is relevant when multiple configurations are applied.

Returns:
the priority

enrich

void enrich(LayoutContext context)
Enrich the given context with additional information that can be derived from what is already contained.

Parameters:
context - a context for layout configuration

getValue

Object getValue(LayoutOptionData<?> optionData,
                LayoutContext context)
Get the current value for a layout option in the given context.

Parameters:
optionData - a layout option descriptor
context - a context for layout configuration
Returns:
the layout option value, or null if the option has no value in this context

transferValues

void transferValues(KGraphData graphData,
                    LayoutContext context)
Transfer all non-default values that are managed by this layout configuration to the given graph data holder.

Parameters:
graphData - a graph data instance that can hold layout options
context - a context for layout configuration