org.xwiki.rendering.listener.chaining
Enum EventType

java.lang.Object
  java.lang.Enum<EventType>
      org.xwiki.rendering.listener.chaining.EventType

All Implemented Interfaces:

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

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

Stores event types and offers a way to call a stored event.

Since:

1.8RC1

Version:

$Id$

Enum Constant Summary

BEGIN_DEFINITION_DESCRIPTION

BEGIN_DEFINITION_LIST

BEGIN_DEFINITION_TERM

BEGIN_DOCUMENT

BEGIN_FORMAT

BEGIN_GROUP

BEGIN_HEADER

BEGIN_LINK

BEGIN_LIST

BEGIN_LIST_ITEM

BEGIN_MACRO_MARKER

BEGIN_METADATA

BEGIN_PARAGRAPH

BEGIN_QUOTATION

BEGIN_QUOTATION_LINE

BEGIN_SECTION

BEGIN_TABLE

BEGIN_TABLE_CELL

BEGIN_TABLE_HEAD_CELL

BEGIN_TABLE_ROW

END_DEFINITION_DESCRIPTION

END_DEFINITION_LIST

END_DEFINITION_TERM

END_DOCUMENT

END_FORMAT

END_GROUP

END_HEADER

END_LINK

END_LIST

END_LIST_ITEM

END_MACRO_MARKER

END_METADATA

END_PARAGRAPH

END_QUOTATION

END_QUOTATION_LINE

END_SECTION

END_TABLE

END_TABLE_CELL

END_TABLE_HEAD_CELL

END_TABLE_ROW

ON_EMPTY_LINES

ON_HORIZONTAL_LINE

ON_ID

ON_IMAGE

ON_MACRO

ON_NEW_LINE

ON_RAW_TEXT

ON_SPACE

ON_SPECIAL_SYMBOL

ON_VERBATIM

ON_WORD

Method Summary

abstract void	fireEvent(Listener listener, java.lang.Object[] eventParameters)
boolean	isInlineEnd()
static EventType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EventType[]	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

BEGIN_DOCUMENT

public static final EventType BEGIN_DOCUMENT

END_DOCUMENT

public static final EventType END_DOCUMENT

BEGIN_GROUP

public static final EventType BEGIN_GROUP

END_GROUP

public static final EventType END_GROUP

BEGIN_PARAGRAPH

public static final EventType BEGIN_PARAGRAPH

END_PARAGRAPH

public static final EventType END_PARAGRAPH

BEGIN_DEFINITION_LIST

public static final EventType BEGIN_DEFINITION_LIST

END_DEFINITION_LIST

public static final EventType END_DEFINITION_LIST

BEGIN_DEFINITION_TERM

public static final EventType BEGIN_DEFINITION_TERM

END_DEFINITION_TERM

public static final EventType END_DEFINITION_TERM

BEGIN_DEFINITION_DESCRIPTION

public static final EventType BEGIN_DEFINITION_DESCRIPTION

END_DEFINITION_DESCRIPTION

public static final EventType END_DEFINITION_DESCRIPTION

BEGIN_FORMAT

public static final EventType BEGIN_FORMAT

END_FORMAT

public static final EventType END_FORMAT

BEGIN_HEADER

public static final EventType BEGIN_HEADER

END_HEADER

public static final EventType END_HEADER

BEGIN_LINK

public static final EventType BEGIN_LINK

END_LINK

public static final EventType END_LINK

BEGIN_LIST

public static final EventType BEGIN_LIST

END_LIST

public static final EventType END_LIST

BEGIN_LIST_ITEM

public static final EventType BEGIN_LIST_ITEM

END_LIST_ITEM

public static final EventType END_LIST_ITEM

BEGIN_MACRO_MARKER

public static final EventType BEGIN_MACRO_MARKER

END_MACRO_MARKER

public static final EventType END_MACRO_MARKER

BEGIN_QUOTATION

public static final EventType BEGIN_QUOTATION

END_QUOTATION

public static final EventType END_QUOTATION

BEGIN_QUOTATION_LINE

public static final EventType BEGIN_QUOTATION_LINE

END_QUOTATION_LINE

public static final EventType END_QUOTATION_LINE

BEGIN_SECTION

public static final EventType BEGIN_SECTION

END_SECTION

public static final EventType END_SECTION

BEGIN_TABLE

public static final EventType BEGIN_TABLE

END_TABLE

public static final EventType END_TABLE

BEGIN_TABLE_CELL

public static final EventType BEGIN_TABLE_CELL

END_TABLE_CELL

public static final EventType END_TABLE_CELL

BEGIN_TABLE_HEAD_CELL

public static final EventType BEGIN_TABLE_HEAD_CELL

END_TABLE_HEAD_CELL

public static final EventType END_TABLE_HEAD_CELL

BEGIN_TABLE_ROW

public static final EventType BEGIN_TABLE_ROW

END_TABLE_ROW

public static final EventType END_TABLE_ROW

BEGIN_METADATA

public static final EventType BEGIN_METADATA

END_METADATA

public static final EventType END_METADATA

ON_RAW_TEXT

public static final EventType ON_RAW_TEXT

ON_EMPTY_LINES

public static final EventType ON_EMPTY_LINES

ON_HORIZONTAL_LINE

public static final EventType ON_HORIZONTAL_LINE

ON_ID

public static final EventType ON_ID

ON_IMAGE

public static final EventType ON_IMAGE

ON_MACRO

public static final EventType ON_MACRO

ON_NEW_LINE

public static final EventType ON_NEW_LINE

ON_SPACE

public static final EventType ON_SPACE

ON_SPECIAL_SYMBOL

public static final EventType ON_SPECIAL_SYMBOL

ON_VERBATIM

public static final EventType ON_VERBATIM

ON_WORD

public static final EventType ON_WORD

Method Detail

values

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

Returns:

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

valueOf

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

fireEvent

public abstract void fireEvent(Listener listener,
                               java.lang.Object[] eventParameters)

isInlineEnd

public boolean isInlineEnd()