|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.kiml.LayoutAlgorithmData
public class LayoutAlgorithmData
Data type used to store information for a layout algorithm.
Field Summary | |
---|---|
static String |
DEFAULT_LAYOUTER_NAME
default name for layout algorithms for which no name is given. |
static int |
MIN_PRIORITY
The minimal allowed priority value. |
Constructor Summary | |
---|---|
LayoutAlgorithmData()
|
Method Summary | |
---|---|
void |
createPool(IFactory<AbstractLayoutProvider> providerFactory)
Sets the layout provider that can execute the associated algorithm. |
boolean |
equals(Object obj)
|
String |
getCategory()
Returns the category. |
Object |
getDefaultValue(LayoutOptionData<?> optionData)
Returns the layout algorithm's default value for the given option. |
String |
getDescription()
Returns the description. |
String |
getId()
Returns the id. |
String |
getName()
Returns the name. |
Object |
getPreviewImage()
Returns the preview image data. |
InstancePool<AbstractLayoutProvider> |
getProviderPool()
Returns an instance pool for layout providers. |
int |
getSupportedPriority(String diagramType)
Returns the supported priority for the given diagram type. |
String |
getType()
Returns the type. |
int |
hashCode()
|
boolean |
knowsOption(LayoutOptionData<?> optionData)
Determines whether the layout algorithm knows the given layout option. |
void |
setCategory(String thecategory)
Sets the category. |
void |
setDescription(String thedescription)
Sets the description. |
void |
setDiagramSupport(String diagramType,
int priority)
Sets support for the given diagram type. |
void |
setId(String theid)
Sets the id. |
void |
setName(String thename)
Sets the name. |
void |
setOption(LayoutOptionData<?> optionData,
Object defaultValue)
Sets the knowledge status of the given layout option. |
void |
setPreviewImage(Object thepreviewImage)
Sets the preview image data. |
void |
setType(String thetype)
Sets the type. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int MIN_PRIORITY
public static final String DEFAULT_LAYOUTER_NAME
Constructor Detail |
---|
public LayoutAlgorithmData()
Method Detail |
---|
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String toString()
toString
in class Object
public void setOption(LayoutOptionData<?> optionData, Object defaultValue)
optionData
- layout option datadefaultValue
- the default value, or null
if none is specifiedpublic boolean knowsOption(LayoutOptionData<?> optionData)
optionData
- layout option data
public Object getDefaultValue(LayoutOptionData<?> optionData)
optionData
- layout option data
null
if there is nonepublic void setDiagramSupport(String diagramType, int priority)
MIN_PRIORITY
, the type is treated as not supported.
diagramType
- identifier of diagram typepriority
- priority value, or MIN_PRIORITY
if the diagram type
is not supportedpublic int getSupportedPriority(String diagramType)
MIN_PRIORITY
is returned.
diagramType
- diagram type identifier
MIN_PRIORITY
if the diagram
type is not supportedpublic void setId(String theid)
setId
in interface ILayoutData
theid
- the id to setpublic String getId()
getId
in interface ILayoutData
public void setName(String thename)
setName
in interface ILayoutData
thename
- the name to setpublic String getName()
getName
in interface ILayoutData
public void setDescription(String thedescription)
setDescription
in interface ILayoutData
thedescription
- the description to setpublic String getDescription()
getDescription
in interface ILayoutData
public void createPool(IFactory<AbstractLayoutProvider> providerFactory)
providerFactory
- a factory for layout providerspublic InstancePool<AbstractLayoutProvider> getProviderPool()
public void setType(String thetype)
thetype
- the type to setpublic String getType()
public void setCategory(String thecategory)
thecategory
- the category to setpublic String getCategory()
public Object getPreviewImage()
public void setPreviewImage(Object thepreviewImage)
thepreviewImage
- the preview image to set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |