com.yworks.yfiles.layout

Class ComponentArrangementStyles

java.lang.Object

java.lang.Number

com.yworks.yfiles.utils.FlagsEnum<ComponentArrangementStyles>

com.yworks.yfiles.layout.ComponentArrangementStyles

All Implemented Interfaces:

Serializable

public final class ComponentArrangementStyles
extends FlagsEnum<ComponentArrangementStyles>

See Also:

ComponentLayout.getStyle(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ComponentArrangementStyles	MASK A constant for masking actual style constants from style modifiers.
static ComponentArrangementStyles	MODIFIER_AS_IS A modifier that can be added to normal style specifiers to indicate that the arrangement strategy should take the initial positions of the components into account.
static ComponentArrangementStyles	MODIFIER_NO_OVERLAP A modifier that can be added to normal style specifiers to indicate that the arrangement strategy should produce a non-overlapping component layout.
static ComponentArrangementStyles	MULTI_ROWS Style specifier describing a component arrangement strategy that places components in multiple rows.
static ComponentArrangementStyles	MULTI_ROWS_COMPACT Style specifier describing a component arrangement strategy that places components in multiple rows.
static ComponentArrangementStyles	MULTI_ROWS_HEIGHT_CONSTRAINT Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted height.
static ComponentArrangementStyles	MULTI_ROWS_HEIGHT_CONSTRAINT_COMPACT Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted height and as compact as possible.
static ComponentArrangementStyles	MULTI_ROWS_WIDTH_CONSTRAINT Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted width.
static ComponentArrangementStyles	MULTI_ROWS_WIDTH_CONSTRAINT_COMPACT Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted width and as compact as possible.
static ComponentArrangementStyles	NONE Style specifier describing no special component arrangement at all.
static ComponentArrangementStyles	PACKED_CIRCLE Style specifier describing a component arrangement strategy that places components in a circular cloud around the biggest component.
static ComponentArrangementStyles	PACKED_COMPACT_CIRCLE Style specifier describing a component arrangement strategy that places components in a circular compact cloud around the biggest component.
static ComponentArrangementStyles	PACKED_COMPACT_RECTANGLE Style specifier describing a component arrangement strategy that places components in a rectangular cloud around the biggest component.
static ComponentArrangementStyles	PACKED_RECTANGLE Style specifier describing a component arrangement strategy that places components in a rectangular cloud around the biggest component.
static ComponentArrangementStyles	ROWS Style specifier describing a component arrangement strategy that places components in multiple rows so that the overall aspect ratio of the whole graph gets as close to the aspect ratio of the preferred layout size as possible.
static ComponentArrangementStyles	SINGLE_COLUMN Style specifier describing a component arrangement strategy that places components above each other in a single column.
static ComponentArrangementStyles	SINGLE_ROW Style specifier describing a component arrangement strategy that places all components next to each other in a single row.

Method Summary

Modifier and Type	Method and Description
static ComponentArrangementStyles	fromName(String name)
static ComponentArrangementStyles	fromOrdinal(int value)
protected ComponentArrangementStyles	fromOrdinalImpl(int ordinal)
protected ComponentArrangementStyles[]	getItems() Returns all items defined in this FlagsEnum.
int	value()

Methods inherited from class com.yworks.yfiles.utils.FlagsEnum

and, and, contains, containsAll, doubleValue, equals, equals, floatValue, hashCode, intValue, inverse, inverse, longValue, notContains, notEquals, or, or, ordinal, toString, xor, xor

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MASK

public static final ComponentArrangementStyles MASK

A constant for masking actual style constants from style modifiers.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles)

MODIFIER_AS_IS

public static final ComponentArrangementStyles MODIFIER_AS_IS

A modifier that can be added to normal style specifiers to indicate that the arrangement strategy should take the initial positions of the components into account.

Combining this modifier is supported with the following styles: SINGLE_ROW, SINGLE_COLUMN, PACKED_RECTANGLE, PACKED_COMPACT_RECTANGLE, PACKED_CIRCLE and PACKED_COMPACT_CIRCLE.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles)

MODIFIER_NO_OVERLAP

public static final ComponentArrangementStyles MODIFIER_NO_OVERLAP

A modifier that can be added to normal style specifiers to indicate that the arrangement strategy should produce a non-overlapping component layout.

Combining this modifier is not supported with NONE.

Non-overlapping component layout (in the sense that no elements from adjacent components overlap) is inherently supported by all styles except for NONE.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles)

MULTI_ROWS

public static final ComponentArrangementStyles MULTI_ROWS

Style specifier describing a component arrangement strategy that places components in multiple rows.

The strategy tries to arrange the components such that the aspect ratio of the final component placement gets as close as possible to the aspect ratio of the preferred layout size, configurable using PreferredSize.

In contrast to ROWS, each row may also be divided into further sub-rows, which is especially useful if there are few very large components and many significantly smaller ones.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles), ComponentLayout.setPreferredSize(com.yworks.yfiles.algorithms.YDimension)

MULTI_ROWS_COMPACT

public static final ComponentArrangementStyles MULTI_ROWS_COMPACT

Style specifier describing a component arrangement strategy that places components in multiple rows.

The strategy tries to arrange the components such that the aspect ratio of the final component placement gets close to the aspect ratio of the preferred layout size, configurable using PreferredSize. But in contrast to MULTI_ROWS, this strategy does not always try to come as close to the preferred view ratio, if a ratio close to the preferred ratio only induces a lot of unused view space. This unused space will be minimized.

In contrast to ROWS, each row may also be divided into further sub-rows, which is especially useful if there are few very large components and many significantly smaller ones.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles), ComponentLayout.setPreferredSize(com.yworks.yfiles.algorithms.YDimension)

MULTI_ROWS_HEIGHT_CONSTRAINT

public static final ComponentArrangementStyles MULTI_ROWS_HEIGHT_CONSTRAINT

Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted height. The resulting height does not exceed the preferred height (PreferredSize).

In contrast to MULTI_ROWS_HEIGHT_CONSTRAINT_COMPACT, the result will be an arrangement which uses as much height as possible, even if that means that all components will be arranged in one single column.

The preferred width and thus the aspect ratio will be ignored.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles), ComponentLayout.setPreferredSize(com.yworks.yfiles.algorithms.YDimension)

MULTI_ROWS_HEIGHT_CONSTRAINT_COMPACT

public static final ComponentArrangementStyles MULTI_ROWS_HEIGHT_CONSTRAINT_COMPACT

Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted height and as compact as possible. The resulting height does not exceed the preferred height (PreferredSize).

In comparison with MULTI_ROWS_HEIGHT_CONSTRAINT, the result will be compacted, which means that an arrangement with the minimum width such that the height constraint is still fulfilled will be realized.

The preferred width and thus the aspect ratio will be ignored.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles), ComponentLayout.setPreferredSize(com.yworks.yfiles.algorithms.YDimension)

MULTI_ROWS_WIDTH_CONSTRAINT

public static final ComponentArrangementStyles MULTI_ROWS_WIDTH_CONSTRAINT

Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted width. The resulting width does not exceed the preferred width (PreferredSize).

In contrast to MULTI_ROWS_WIDTH_CONSTRAINT_COMPACT the result will be an arrangement which uses as much space in width as possible, even if that means that all components will be arranged in a single row.

The preferred height and thus the aspect ratio will be ignored.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles), ComponentLayout.setPreferredSize(com.yworks.yfiles.algorithms.YDimension)

MULTI_ROWS_WIDTH_CONSTRAINT_COMPACT

public static final ComponentArrangementStyles MULTI_ROWS_WIDTH_CONSTRAINT_COMPACT

Style specifier describing a component arrangement strategy that places the components in MULTI_ROWS with a restricted width and as compact as possible. The resulting width does not exceed the preferred width (PreferredSize).

In comparison with MULTI_ROWS_HEIGHT_CONSTRAINT the result will be compacted, in order to minimize unused view space induced by components that are large in height.

The preferred height and thus the aspect ratio will be ignored.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles), ComponentLayout.setPreferredSize(com.yworks.yfiles.algorithms.YDimension)

NONE

public static final ComponentArrangementStyles NONE

Style specifier describing no special component arrangement at all. Components will be centered at the same position they resided at before the layout started. If combined with the style modifier MODIFIER_NO_OVERLAP, components might get moved so that they don't overlap after the layout.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles)

PACKED_CIRCLE

public static final ComponentArrangementStyles PACKED_CIRCLE

Style specifier describing a component arrangement strategy that places components in a circular cloud around the biggest component. Entities of different components will not overlap, however the bounding boxes of the components may overlap.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles)

PACKED_COMPACT_CIRCLE

public static final ComponentArrangementStyles PACKED_COMPACT_CIRCLE

Style specifier describing a component arrangement strategy that places components in a circular compact cloud around the biggest component. Entities of different components will not overlap, however the bounding boxes of the components may overlap.

In contrast to PACKED_CIRCLE, components might even be placed in empty spaces inside other components.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles)

PACKED_COMPACT_RECTANGLE

public static final ComponentArrangementStyles PACKED_COMPACT_RECTANGLE

Style specifier describing a component arrangement strategy that places components in a rectangular cloud around the biggest component. Entities of different components will not overlap, however the bounding boxes of the components may overlap.

In contrast to PACKED_RECTANGLE, components might even be placed in empty spaces inside other components.

The aspect ratio of the rectangle is defined by the preferred size of the graph.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles), ComponentLayout.setPreferredSize(com.yworks.yfiles.algorithms.YDimension)

PACKED_RECTANGLE

public static final ComponentArrangementStyles PACKED_RECTANGLE

Style specifier describing a component arrangement strategy that places components in a rectangular cloud around the biggest component. Entities of different components will not overlap, however the bounding boxes of the components may overlap.

The aspect ratio of the rectangle is defined by the preferred size of the graph.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles), ComponentLayout.setPreferredSize(com.yworks.yfiles.algorithms.YDimension)

ROWS

public static final ComponentArrangementStyles ROWS

Style specifier describing a component arrangement strategy that places components in multiple rows so that the overall aspect ratio of the whole graph gets as close to the aspect ratio of the preferred layout size as possible.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles), ComponentLayout.setPreferredSize(com.yworks.yfiles.algorithms.YDimension)

SINGLE_COLUMN

public static final ComponentArrangementStyles SINGLE_COLUMN

Style specifier describing a component arrangement strategy that places components above each other in a single column. If combined with the style modifier MODIFIER_AS_IS, components will be placed in the same order as they were placed before the layout.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles)

SINGLE_ROW

public static final ComponentArrangementStyles SINGLE_ROW

Style specifier describing a component arrangement strategy that places all components next to each other in a single row. If combined with the style modifier MODIFIER_AS_IS, components will be placed in the same order as they were placed before the layout.

See Also:

ComponentLayout.setStyle(ComponentArrangementStyles)

Method Detail

fromName

public static final ComponentArrangementStyles fromName(String name)

fromOrdinal

public static final ComponentArrangementStyles fromOrdinal(int value)

fromOrdinalImpl

protected final ComponentArrangementStyles fromOrdinalImpl(int ordinal)

Specified by:

fromOrdinalImpl in class FlagsEnum<ComponentArrangementStyles>

getItems

protected final ComponentArrangementStyles[] getItems()

Description copied from class: FlagsEnum

Returns all items defined in this FlagsEnum.

Specified by:

getItems in class FlagsEnum<ComponentArrangementStyles>

value

public int value()