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

All Superinterfaces:
ILayoutConfig
All Known Implementing Classes:
ActionLayoutConfig, AnnotationsLayoutConfig, AnnotationsLayoutConfig, CompoundLayoutConfig, GmfLayoutConfig, GraphitiLayoutConfig, HVLayoutConfig, HypernodeLayoutConfig, SemanticLayoutConfig, TypeLayoutConfig

public interface IMutableLayoutConfig
extends ILayoutConfig

An extension of the layout configuration interface for configurations that can be altered.

Rating red

Field Summary
static IProperty<Boolean> OPT_RECURSIVE
          option for layout context: whether changes should be applied also for all child elements.
 
Method Summary
 void clearValues(LayoutContext context)
          Clear all layout option values that have been set for the given context.
 boolean isSet(LayoutOptionData<?> optionData, LayoutContext context)
          Determine whether the given layout option is set, not considering any default values.
 void setValue(LayoutOptionData<?> optionData, LayoutContext context, Object value)
          Set a new value for a layout option in the given context.
 
Methods inherited from interface de.cau.cs.kieler.kiml.config.ILayoutConfig
enrich, getPriority, getValue, transferValues
 

Field Detail

OPT_RECURSIVE

static final IProperty<Boolean> OPT_RECURSIVE
option for layout context: whether changes should be applied also for all child elements.

Method Detail

setValue

void setValue(LayoutOptionData<?> optionData,
              LayoutContext context,
              Object value)
Set a new value for a layout option in the given context.

Parameters:
optionData - a layout option descriptor
context - a context for layout configuration
value - the new layout option value, or null if the current value shall be removed

clearValues

void clearValues(LayoutContext context)
Clear all layout option values that have been set for the given context.

Parameters:
context - a context for layout configuration

isSet

boolean isSet(LayoutOptionData<?> optionData,
              LayoutContext context)
Determine whether the given layout option is set, not considering any default values.

Parameters:
optionData - a layout option descriptor
context - a context for layout configuration
Returns:
true if the option is set