|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.kiml.options.LayoutOptions
public final class LayoutOptions
Definition of layout options and utility methods to get and set these options.
Field Summary | |
---|---|
static String |
ASPECT_RATIO
layout option key: aimed aspect ratio. |
static String |
BORDER_SPACING
layout option key: distance to border of the drawing. |
static String |
DIAGRAM_TYPE
layout option key: diagram type. |
static String |
EDGE_LABEL_PLACEMENT
layout option key: placement positions for edge labels. |
static String |
EDGE_ROUTING
layout option key: edge routing style. |
static String |
EDGE_TYPE
layout option key: edge type. |
static String |
EXPAND_NODES
layout option key: expand nodes to fill their parent. |
static String |
FIXED_SIZE
layout option key: size constraint for nodes. |
static String |
FONT_NAME
layout option key: font name. |
static String |
FONT_SIZE
layout option key: font size. |
static String |
INSETS
layout option key: distance of node contents to the boundary. |
static String |
INTERACTIVE
layout option key: optimize layout for user interaction. |
static String |
LABEL_SPACING
layout option key: spacing of edge labels to edges. |
static String |
LAYOUT_DESCENDANTS
layout option key: layout descendants. |
static String |
LAYOUT_DIRECTION
layout option key: direction of layout. |
static String |
LAYOUT_HINT
layout option key: layout hint. |
static String |
MIN_HEIGHT
layout option key: minimal height. |
static String |
MIN_SPACING
layout option key: minimal distance between elements. |
static String |
MIN_WIDTH
layout option key: minimal width. |
static String |
NO_LAYOUT
layout option key: no layout. |
static String |
PORT_CONSTRAINTS
layout option key: constraints for port positions. |
static String |
PORT_RANK
layout option key: rank of a port. |
static String |
PORT_SIDE
layout option key: side of a port on its node's boundary. |
static String |
PRIORITY
layout option key: priority of elements. |
static String |
RANDOM_SEED
layout option key: randomization seed. |
static String |
SHAPE
layout option key: shape of a node. |
Method Summary | ||
---|---|---|
static boolean |
getBoolean(KLayoutData layoutData,
String optionId)
Returns a boolean valued option for a given layout data instance. |
|
static
|
getEnum(KLayoutData layoutData,
Class<T> enumClass)
Returns an enumeration valued option for a given layout data instance. |
|
static Class<? extends Enum<?>> |
getEnumClass(String optionId)
Resolves the class of an enumeration given by an identifier. |
|
static float |
getFloat(KLayoutData layoutData,
String optionId)
Returns a float valued option for a given layout data instance. |
|
static int |
getInt(KLayoutData layoutData,
String optionId)
Returns an integer valued option for a given layout data instance. |
|
static
|
getObject(KLayoutData layoutData,
Class<T> clazz)
Returns the insets for a given layout data instance. |
|
static String |
getString(KLayoutData layoutData,
String optionId)
Returns a string valued option for a given layout data instance. |
|
static void |
registerEnum(String id,
Class<? extends Enum<?>> clazz)
Register the given enumeration class with an option identifier. |
|
static void |
setBoolean(KLayoutData layoutData,
String optionId,
boolean value)
Sets a boolean valued option for a given layout data instance. |
|
static void |
setEnum(KLayoutData layoutData,
Enum<?> value)
Sets an enumeration valued option for the given layout data instance. |
|
static void |
setFloat(KLayoutData layoutData,
String optionId,
float value)
Sets a float valued option for the given layout data instance. |
|
static void |
setInt(KLayoutData layoutData,
String optionId,
int value)
Sets an integer valued option for the given layout data instance. |
|
static void |
setString(KLayoutData layoutData,
String optionId,
String value)
Sets a string valued option for the given layout data instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String ASPECT_RATIO
public static final String BORDER_SPACING
public static final String DIAGRAM_TYPE
public static final String EDGE_LABEL_PLACEMENT
public static final String EDGE_ROUTING
public static final String EDGE_TYPE
public static final String EXPAND_NODES
public static final String FIXED_SIZE
public static final String FONT_NAME
public static final String FONT_SIZE
public static final String INSETS
public static final String INTERACTIVE
public static final String LABEL_SPACING
public static final String LAYOUT_DIRECTION
public static final String LAYOUT_HINT
public static final String MIN_HEIGHT
public static final String MIN_SPACING
public static final String MIN_WIDTH
public static final String NO_LAYOUT
public static final String PORT_CONSTRAINTS
public static final String PORT_SIDE
public static final String PORT_RANK
public static final String PRIORITY
public static final String RANDOM_SEED
public static final String SHAPE
public static final String LAYOUT_DESCENDANTS
Method Detail |
---|
public static void registerEnum(String id, Class<? extends Enum<?>> clazz)
id
- identifier of the layout optionclazz
- enumeration class for the layout optionpublic static Class<? extends Enum<?>> getEnumClass(String optionId)
optionId
- identifier of a layout option that is represented by an
enumeration
null
if there
is no registered enumeration class for that identifierpublic static String getString(KLayoutData layoutData, String optionId)
layoutData
- layout data for a graph elementoptionId
- identifier of a layout option
null
if
there is no such optionpublic static void setString(KLayoutData layoutData, String optionId, String value)
layoutData
- layout data for a graph elementoptionId
- identifier of a layout optionvalue
- the option value to setpublic static int getInt(KLayoutData layoutData, String optionId)
layoutData
- layout data for a graph elementoptionId
- identifier of a layout option
MIN_VALUE
if
there is no such optionpublic static void setInt(KLayoutData layoutData, String optionId, int value)
layoutData
- layout data for a graph elementoptionId
- identifier of a layout optionvalue
- the option value to setpublic static float getFloat(KLayoutData layoutData, String optionId)
layoutData
- layout data for a graph elementoptionId
- identifier of a layout option
NaN
if
there is no such optionpublic static void setFloat(KLayoutData layoutData, String optionId, float value)
layoutData
- layout data for a graph elementoptionId
- identifier of a layout optionvalue
- minimal spacing to setpublic static boolean getBoolean(KLayoutData layoutData, String optionId)
layoutData
- layout data for a graph elementoptionId
- identifier of a layout option
false
if there is no such optionpublic static void setBoolean(KLayoutData layoutData, String optionId, boolean value)
layoutData
- layout data for a graph elementoptionId
- identifier of a layout optionvalue
- the option value to setpublic static <T extends Enum<?>> T getEnum(KLayoutData layoutData, Class<T> enumClass)
T
- type of enumeration classlayoutData
- layout data for a graph elementenumClass
- the enumeration class
public static void setEnum(KLayoutData layoutData, Enum<?> value)
layoutData
- layout data for a graph elementvalue
- the option value to setpublic static <T extends EObject> T getObject(KLayoutData layoutData, Class<T> clazz)
T
- type of object; only insets are supportedlayoutData
- layout data for a graph elementclazz
- the object class; must equal KInsets.class
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |