Media Authoring
with Java API

tv.amwa.maj.enumeration
Enum EditHintType

java.lang.Object
  extended by java.lang.Enum<EditHintType>
      extended by tv.amwa.maj.enumeration.EditHintType
All Implemented Interfaces:
Serializable, Comparable<EditHintType>, AAFEnumerationValue

public enum EditHintType
extends Enum<EditHintType>
implements AAFEnumerationValue

Specifies hints to be used when editing control points. The hint is used to describe how to alter a control point if an operation group that contains it is itself altered in size.

Original C name: aafEditHint_e

Author:
Richard Cartwright
See Also:
ControlPoint, TypeDefinitionEnumeration.EditHintType, OperationGroup

Enum Constant Summary
NoEditHint
          No hint on how to update the control point is provided.
Proportional
          The change to the control point value is in linear proportion to the change in the overall operation group size.
RelativeFixed
          The control point should maintain the same relative difference between itself and the control points either side.
RelativeLeft
          The control point should maintain the same difference between itself and the control point to its left.
RelativeRight
          The control point should maintain the same difference between itself and the control point to its right.
 
Method Summary
 long value()
          Returns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.
static EditHintType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static EditHintType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface tv.amwa.maj.enumeration.AAFEnumerationValue
name
 

Enum Constant Detail

NoEditHint

public static final EditHintType NoEditHint

No hint on how to update the control point is provided.


Proportional

public static final EditHintType Proportional

The change to the control point value is in linear proportion to the change in the overall operation group size.


RelativeLeft

public static final EditHintType RelativeLeft

The control point should maintain the same difference between itself and the control point to its left.


RelativeRight

public static final EditHintType RelativeRight

The control point should maintain the same difference between itself and the control point to its right.


RelativeFixed

public static final EditHintType RelativeFixed

The control point should maintain the same relative difference between itself and the control points either side.

Method Detail

values

public static final EditHintType[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(EditHintType c : EditHintType.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static EditHintType 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

value

@Int64
public long value()
Description copied from interface: AAFEnumerationValue

Returns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.

Specified by:
value in interface AAFEnumerationValue
Returns:
Unique integer value associated with an enumeration constant.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.