Oxygen XML Editor 14.2 Author API

ro.sync.ecss.extensions.api.highlights
Enum AuthorPersistentHighlight.PersistentHighlightType

java.lang.Object
  extended by java.lang.Enum<AuthorPersistentHighlight.PersistentHighlightType>
      extended by ro.sync.ecss.extensions.api.highlights.AuthorPersistentHighlight.PersistentHighlightType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AuthorPersistentHighlight.PersistentHighlightType>
Enclosing interface:
AuthorPersistentHighlight

public static enum AuthorPersistentHighlight.PersistentHighlightType
extends java.lang.Enum<AuthorPersistentHighlight.PersistentHighlightType>

The Author Persistent Highlight type.

CUSTOM_HIGHLIGHT represents the Custom defined highlights that can be managed by using the AuthorPersistentHighlighter. The name of the processing instruction markers corresponding to this type of highlight are oxy_custom_start and oxy_custom_end
COMMENT represents the Comment highlights which get serialized using the oxy_comment_start and oxy_comment_end processing instruction names.
CHANGE_INSERT represents the Insert highlight from Change Tracking, with the oxy_insert_start and oxy_insert_end corresponding processing instruction names.
CHANGE_DELETE represents the Delete highlight from Change Tracking, which get serialized by using the oxy_delete processing instruction name.


Enum Constant Summary
CHANGE_DELETE
          Delete change highlight
CHANGE_INSERT
          Insert change highlight
COMMENT
          Comment persistent highlight
CUSTOM_HIGHLIGHT
          Custom persistent highlight
 
Method Summary
static AuthorPersistentHighlight.PersistentHighlightType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AuthorPersistentHighlight.PersistentHighlightType[] 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

COMMENT

public static final AuthorPersistentHighlight.PersistentHighlightType COMMENT
Comment persistent highlight


CUSTOM_HIGHLIGHT

public static final AuthorPersistentHighlight.PersistentHighlightType CUSTOM_HIGHLIGHT
Custom persistent highlight


CHANGE_INSERT

public static final AuthorPersistentHighlight.PersistentHighlightType CHANGE_INSERT
Insert change highlight


CHANGE_DELETE

public static final AuthorPersistentHighlight.PersistentHighlightType CHANGE_DELETE
Delete change highlight

Method Detail

values

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

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

valueOf

public static AuthorPersistentHighlight.PersistentHighlightType 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

Oxygen XML Editor 14.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2013. All rights reserved.