com.yworks.yfiles.layout.genealogy

Enum FamilyMembersSortingPolicy

java.lang.Object

java.lang.Enum<FamilyMembersSortingPolicy>

com.yworks.yfiles.layout.genealogy.FamilyMembersSortingPolicy

All Implemented Interfaces:

Serializable, Comparable<FamilyMembersSortingPolicy>

public enum FamilyMembersSortingPolicy
extends Enum<FamilyMembersSortingPolicy>

Enum constants that specify how family members are sorted by the FamilyTreeLayout.

See Also:

FamilyTreeLayout.getFamilyMembersSortingPolicy()

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEMALE_ALWAYS_FIRST Order specifier that places female individuals before their male siblings and partners.
FEMALE_FIRST Order specifier that places female individuals before their male siblings and partners, if possible.
MALE_ALWAYS_FIRST Order specifier that places male individuals before their female siblings and partners.
MALE_FIRST Order specifier that places male individuals before their female siblings and partners, if possible.
NO_SORTING Order specifier that disables sorting of individuals according to their sex.

Method Summary

Modifier and Type	Method and Description
static FamilyMembersSortingPolicy	fromOrdinal(int ordinal)
int	value()
static FamilyMembersSortingPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static FamilyMembersSortingPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FEMALE_ALWAYS_FIRST

public static final FamilyMembersSortingPolicy FEMALE_ALWAYS_FIRST

Order specifier that places female individuals before their male siblings and partners.

See Also:

FamilyTreeLayout.setFamilyMembersSortingPolicy(FamilyMembersSortingPolicy)

FEMALE_FIRST

public static final FamilyMembersSortingPolicy FEMALE_FIRST

Order specifier that places female individuals before their male siblings and partners, if possible.

See Also:

FamilyTreeLayout.setFamilyMembersSortingPolicy(FamilyMembersSortingPolicy)

MALE_ALWAYS_FIRST

public static final FamilyMembersSortingPolicy MALE_ALWAYS_FIRST

Order specifier that places male individuals before their female siblings and partners.

See Also:

FamilyTreeLayout.setFamilyMembersSortingPolicy(FamilyMembersSortingPolicy)

MALE_FIRST

public static final FamilyMembersSortingPolicy MALE_FIRST

Order specifier that places male individuals before their female siblings and partners, if possible.

See Also:

FamilyTreeLayout.setFamilyMembersSortingPolicy(FamilyMembersSortingPolicy)

NO_SORTING

public static final FamilyMembersSortingPolicy NO_SORTING

Order specifier that disables sorting of individuals according to their sex.

See Also:

FamilyTreeLayout.setFamilyMembersSortingPolicy(FamilyMembersSortingPolicy)

Method Detail

fromOrdinal

public static final FamilyMembersSortingPolicy fromOrdinal(int ordinal)

value

public int value()

valueOf

public static FamilyMembersSortingPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

values

public static FamilyMembersSortingPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FamilyMembersSortingPolicy c : FamilyMembersSortingPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared