com.objex.progeny.anywhere.enums
Enum PEDIGREE_PROGENY_PROPERTY

java.lang.Object
  java.lang.Enum<PEDIGREE_PROGENY_PROPERTY>
      com.objex.progeny.anywhere.enums.PEDIGREE_PROGENY_PROPERTY

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PEDIGREE_PROGENY_PROPERTY>

public enum PEDIGREE_PROGENY_PROPERTY
extends java.lang.Enum<PEDIGREE_PROGENY_PROPERTY>

Defines constant values for select properties of an pedigree object that are of interest

Enum Constant Summary

AUTODRAW
Set to TRUE to enable auto smartdraw when new persons are added to the pedigree

LIVEDRAGGING
Set to TRUE to show enable live dragging of pedigree icons

ONECLICKADD
Set to TRUE to show once-click-add handles, FALSE to hide them

SHOWFOOTER
Set to TRUE to show footer, FALSE to hide footer

SHOWGRID
Set to TRUE to show grid, FALSE to hide it

SHOWHAPLOTYPES
Set to TRUE to show haplotype bars, FALSE to hide haplotype bars

SHOWHEADER
Set to TRUE to show header, FALSE to hide header

SHOWPAGEBREAKS
Set to TRUE to show page breaks indicating where print margins are expected

SHOWSUBTEXTLEGEND
Set to TRUE to show subtext legend, FALSE to hide it

SHOWSYMBOLSLEGEND
Set to TRUE to show symbols legend, FALSE to hide it

SNAPTOGRID
Set to TRUE to enable snap to grid for aligning icons

Method Summary

int	getProperty()
static PEDIGREE_PROGENY_PROPERTY	valueOf(int ai_property)
static PEDIGREE_PROGENY_PROPERTY	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PEDIGREE_PROGENY_PROPERTY[]	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

SHOWGRID

public static final PEDIGREE_PROGENY_PROPERTY SHOWGRID

Set to TRUE to show grid, FALSE to hide it

SNAPTOGRID

public static final PEDIGREE_PROGENY_PROPERTY SNAPTOGRID

Set to TRUE to enable snap to grid for aligning icons

SHOWPAGEBREAKS

public static final PEDIGREE_PROGENY_PROPERTY SHOWPAGEBREAKS

Set to TRUE to show page breaks indicating where print margins are expected

AUTODRAW

public static final PEDIGREE_PROGENY_PROPERTY AUTODRAW

Set to TRUE to enable auto smartdraw when new persons are added to the pedigree

LIVEDRAGGING

public static final PEDIGREE_PROGENY_PROPERTY LIVEDRAGGING

Set to TRUE to show enable live dragging of pedigree icons

SHOWSYMBOLSLEGEND

public static final PEDIGREE_PROGENY_PROPERTY SHOWSYMBOLSLEGEND

Set to TRUE to show symbols legend, FALSE to hide it

SHOWSUBTEXTLEGEND

public static final PEDIGREE_PROGENY_PROPERTY SHOWSUBTEXTLEGEND

Set to TRUE to show subtext legend, FALSE to hide it

ONECLICKADD

public static final PEDIGREE_PROGENY_PROPERTY ONECLICKADD

Set to TRUE to show once-click-add handles, FALSE to hide them

SHOWHEADER

public static final PEDIGREE_PROGENY_PROPERTY SHOWHEADER

Set to TRUE to show header, FALSE to hide header

SHOWFOOTER

public static final PEDIGREE_PROGENY_PROPERTY SHOWFOOTER

Set to TRUE to show footer, FALSE to hide footer

SHOWHAPLOTYPES

public static final PEDIGREE_PROGENY_PROPERTY SHOWHAPLOTYPES

Set to TRUE to show haplotype bars, FALSE to hide haplotype bars

Method Detail

values

public static PEDIGREE_PROGENY_PROPERTY[] 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 (PEDIGREE_PROGENY_PROPERTY c : PEDIGREE_PROGENY_PROPERTY.values())
    System.out.println(c);

Returns:

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

valueOf

public static PEDIGREE_PROGENY_PROPERTY valueOf(java.lang.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.)

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

java.lang.NullPointerException - if the argument is null

getProperty

public int getProperty()

Returns:

The property ID for the Enum

valueOf

public static PEDIGREE_PROGENY_PROPERTY valueOf(int ai_property)

Parameters:

ai_property - The property ID related to the required enum

Returns:

The enum value for a give prperty ID