com.yworks.yfiles.view.input

Enum PortCandidateValidity

java.lang.Object

java.lang.Enum<PortCandidateValidity>

com.yworks.yfiles.view.input.PortCandidateValidity

All Implemented Interfaces:

Serializable, Comparable<PortCandidateValidity>

public enum PortCandidateValidity
extends Enum<PortCandidateValidity>

Enumeration for the different possible Validity states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DYNAMIC The candidate cannot be used to create a port, instead IPortCandidate.getPortCandidateAt(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.PointD) needs to be called to obtain a IPortCandidate that is either VALID or INVALID.
INVALID The candidate should not be used to connect an edge to.
VALID The candidate is valid and can be used to connect an edge to.

Method Summary

Modifier and Type	Method and Description
static PortCandidateValidity	fromOrdinal(int ordinal)
int	value()
static PortCandidateValidity	valueOf(String name) Returns the enum constant of this type with the specified name.
static PortCandidateValidity[]	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

DYNAMIC

public static final PortCandidateValidity DYNAMIC

The candidate cannot be used to create a port, instead IPortCandidate.getPortCandidateAt(com.yworks.yfiles.view.input.IInputModeContext, com.yworks.yfiles.geometry.PointD) needs to be called to obtain a IPortCandidate that is either VALID or INVALID.

INVALID

public static final PortCandidateValidity INVALID

The candidate should not be used to connect an edge to.

VALID

public static final PortCandidateValidity VALID

The candidate is valid and can be used to connect an edge to.

Method Detail

fromOrdinal

public static final PortCandidateValidity fromOrdinal(int ordinal)

value

public int value()

valueOf

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

Returns:

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