Package org.odftoolkit.odfdom.type

Enum TargetFrameName

java.lang.Object

java.lang.Enum<TargetFrameName>

org.odftoolkit.odfdom.type.TargetFrameName

All Implemented Interfaces:

Serializable, Comparable<TargetFrameName>, OdfDataType

public enum TargetFrameName
extends Enum<TargetFrameName>
implements OdfDataType

This class represents the in OpenDocument format used data type targetFrameName

Enum Constant Summary

Enum Constants

Enum Constant	Description
_BLANK
_PARENT
_SELF
_TOP

Method Summary

Modifier and Type	Method	Description
static TargetFrameName	enumValueOf(String stringValue)	String to enum, turns a String into its corresponding enum constant
static boolean	isValid(String stringValue)	check if the specified String is a valid targetFrameName data type
String	toString()	gets the name of this enum.
static String	toString(TargetFrameName aEnum)	enum to String, gets the name of this enum constant as a string.
static TargetFrameName	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TargetFrameName[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

_SELF

public static final TargetFrameName _SELF

_BLANK

public static final TargetFrameName _BLANK

_PARENT

public static final TargetFrameName _PARENT

_TOP

public static final TargetFrameName _TOP

Method Detail

values

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

Returns:

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

valueOf

public static TargetFrameName 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.)

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null

toString

public String toString()

gets the name of this enum.

Overrides:

toString in class Enum<TargetFrameName>

Returns:

return the name of TargetFrameNameType

toString

public static String toString(TargetFrameName aEnum)

enum to String, gets the name of this enum constant as a string.

Parameters:

aEnum - the constant of TargetFrameName

Returns:

return the name of TargetFrameName

enumValueOf

public static TargetFrameName enumValueOf(String stringValue)

String to enum, turns a String into its corresponding enum constant

Parameters:

stringValue - the name of OdfTargetFrameNameType

Returns:

return the constant of OdfTargetFrameNameType

isValid

public static boolean isValid(String stringValue)

check if the specified String is a valid targetFrameName data type

Parameters:

stringValue - the value to be tested

Returns:

true if the value of argument is valid for targetFrameName data type false otherwise