|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.kiml.DefaultLayoutConfig
public class DefaultLayoutConfig
Default implementation of the layout configuration interface. This configuration handles the default values of layout providers and layout options.
Constructor Summary | |
---|---|
DefaultLayoutConfig()
|
Method Summary | ||
---|---|---|
void |
clearProperties()
Throws an UnsupportedOperationException , since this configuration cannot be
used to change default values. |
|
void |
copyProperties(IPropertyHolder holder)
Throws an UnsupportedOperationException , since this configuration cannot be
used to change default values. |
|
Map<IProperty<?>,Object> |
getAllProperties()
Returns a map of all layout options that are available for the selected element to their default values. |
|
LayoutProviderData |
getContainerLayouterData()
Returns the layout provider descriptor for the container of the associated element. |
|
LayoutProviderData |
getContentLayouterData()
Returns the layout provider descriptor for the content of the associated element. |
|
LayoutProviderData |
getLayouterData(String theLayoutHint,
String diagramType)
Returns the most appropriate layout provider for the given layout hint and diagram type. |
|
List<LayoutOptionData<?>> |
getOptionData()
Returns a list of available layout option descriptors. |
|
|
getProperty(IProperty<T> property)
Retrieve the default value for a layout option. |
|
void |
initialize(LayoutOptionData.Target targetType,
String layoutHint,
String diagramType)
Initialize the configuration with a layout hint and diagram type for the content or the container of the selected element. |
|
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)
Initialize the configuration with a layout hint. |
|
void |
setProperty(IProperty<?> property,
Object value)
Throws an UnsupportedOperationException , since this configuration cannot be
used to change default values. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultLayoutConfig()
Method Detail |
---|
public void setFocus(Object element)
setFocus
in interface ILayoutConfig
element
- a layout hint of type String
public final void initialize(LayoutOptionData.Target targetType, String layoutHint, String diagramType)
targetType
- type of the selected element (parent, node, edge, port, etc.)layoutHint
- a layout hint, or null
diagramType
- a diagram type, or null
public List<LayoutOptionData<?>> getOptionData()
getOptionData
in interface ILayoutConfig
public Map<IProperty<?>,Object> getAllProperties()
getAllProperties
in interface IPropertyHolder
public <T> T getProperty(IProperty<T> property)
initialize
to be called first in order to work properly.
getProperty
in interface IPropertyHolder
T
- type of optionproperty
- a layout option
public boolean isDefault(LayoutOptionData<?> optionData)
isDefault
in interface ILayoutConfig
optionData
- layout option data
public LayoutProviderData getContentLayouterData()
getContentLayouterData
in interface ILayoutConfig
public LayoutProviderData getContainerLayouterData()
getContainerLayouterData
in interface ILayoutConfig
public LayoutProviderData getLayouterData(String theLayoutHint, String diagramType)
getLayouterData
in interface ILayoutConfig
theLayoutHint
- identifier of either a layout provider or a layout typediagramType
- identifier of a diagram type
null
public void setProperty(IProperty<?> property, Object value)
UnsupportedOperationException
, since this configuration cannot be
used to change default values.
setProperty
in interface IPropertyHolder
property
- a layout optionvalue
- an option valuepublic void copyProperties(IPropertyHolder holder)
UnsupportedOperationException
, since this configuration cannot be
used to change default values.
copyProperties
in interface IPropertyHolder
holder
- a property holderpublic void clearProperties()
UnsupportedOperationException
, since this configuration cannot be
used to change default values.
clearProperties
in interface ILayoutConfig
public void setDiagramDefault(LayoutOptionData<?> optionData, Object value)
UnsupportedOperationException
, since this configuration cannot be
used to change default values.
setDiagramDefault
in interface ILayoutConfig
optionData
- a layout optionvalue
- an option value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |