EventType (XWiki Rendering - Api 13.6-rc-1 API)

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

All Implemented Interfaces:

Serializable, Comparable<EventType>
```
public enum EventType
extends Enum<EventType>
```
Stores event types and offers a way to call a stored event.

Since:

1.8RC1

Version:

$Id: 62bd6afe5c404e0c7e1aa2e6da4ea252d8855304 $

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BEGIN_DEFINITION_DESCRIPTION`
`BEGIN_DEFINITION_LIST`
`BEGIN_DEFINITION_TERM`
`BEGIN_DOCUMENT`
`BEGIN_FIGURE`
`BEGIN_FIGURE_CAPTION`
`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_FIGURE`
`END_FIGURE_CAPTION`
`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

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`fireEvent(Listener listener, Object... eventParameters)` Calls an event method on the passed listener with the passed parameters.
`boolean`	`isInlineEnd()`
`static EventType`	`valueOf(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
```
    See Also:
    
    Listener.beginDocument(org.xwiki.rendering.listener.MetaData)
  - END_DOCUMENT
```
public static final EventType END_DOCUMENT
```
    See Also:
    
    Listener.endDocument(org.xwiki.rendering.listener.MetaData)
  - BEGIN_GROUP
```
public static final EventType BEGIN_GROUP
```
    See Also:
    
    Listener.beginGroup(java.util.Map)
  - END_GROUP
```
public static final EventType END_GROUP
```
    See Also:
    
    Listener.endGroup(java.util.Map)
  - BEGIN_PARAGRAPH
```
public static final EventType BEGIN_PARAGRAPH
```
    See Also:
    
    Listener.beginParagraph(java.util.Map)
  - END_PARAGRAPH
```
public static final EventType END_PARAGRAPH
```
    See Also:
    
    Listener.endParagraph(java.util.Map)
  - BEGIN_DEFINITION_LIST
```
public static final EventType BEGIN_DEFINITION_LIST
```
    See Also:
    
    Listener.beginDefinitionList(java.util.Map)
  - END_DEFINITION_LIST
```
public static final EventType END_DEFINITION_LIST
```
    See Also:
    
    Listener.endDefinitionList(java.util.Map)
  - BEGIN_DEFINITION_TERM
```
public static final EventType BEGIN_DEFINITION_TERM
```
    See Also:
    
    Listener.beginDefinitionTerm()
  - END_DEFINITION_TERM
```
public static final EventType END_DEFINITION_TERM
```
    See Also:
    
    Listener.endDefinitionTerm()
  - BEGIN_DEFINITION_DESCRIPTION
```
public static final EventType BEGIN_DEFINITION_DESCRIPTION
```
    See Also:
    
    Listener.beginDefinitionDescription()
  - END_DEFINITION_DESCRIPTION
```
public static final EventType END_DEFINITION_DESCRIPTION
```
    See Also:
    
    Listener.endDefinitionDescription()
  - BEGIN_FORMAT
```
public static final EventType BEGIN_FORMAT
```
    See Also:
    
    Listener.beginFormat(org.xwiki.rendering.listener.Format, java.util.Map)
  - END_FORMAT
```
public static final EventType END_FORMAT
```
    See Also:
    
    Listener.endFormat(org.xwiki.rendering.listener.Format, java.util.Map)
  - BEGIN_HEADER
```
public static final EventType BEGIN_HEADER
```
    See Also:
    
    Listener.beginHeader(org.xwiki.rendering.listener.HeaderLevel, String, java.util.Map)
  - END_HEADER
```
public static final EventType END_HEADER
```
    See Also:
    
    Listener.endHeader(org.xwiki.rendering.listener.HeaderLevel, String, java.util.Map)
  - BEGIN_LINK
```
public static final EventType BEGIN_LINK
```
    See Also:
    
    LinkListener.beginLink(org.xwiki.rendering.listener.reference.ResourceReference, boolean, java.util.Map)
  - END_LINK
```
public static final EventType END_LINK
```
    See Also:
    
    LinkListener.endLink(org.xwiki.rendering.listener.reference.ResourceReference, boolean, java.util.Map)
  - BEGIN_LIST
```
public static final EventType BEGIN_LIST
```
    See Also:
    
    Listener.beginList(org.xwiki.rendering.listener.ListType, java.util.Map)
  - END_LIST
```
public static final EventType END_LIST
```
    See Also:
    
    Listener.endList(org.xwiki.rendering.listener.ListType, java.util.Map)
  - BEGIN_LIST_ITEM
```
public static final EventType BEGIN_LIST_ITEM
```
    See Also:
    
    Listener.beginListItem()
  - END_LIST_ITEM
```
public static final EventType END_LIST_ITEM
```
    See Also:
    
    Listener.endListItem()
  - BEGIN_MACRO_MARKER
```
public static final EventType BEGIN_MACRO_MARKER
```
    See Also:
    
    Listener.beginMacroMarker(String, java.util.Map, String, boolean)
  - END_MACRO_MARKER
```
public static final EventType END_MACRO_MARKER
```
    See Also:
    
    Listener.endMacroMarker(String, java.util.Map, String, boolean)
  - BEGIN_QUOTATION
```
public static final EventType BEGIN_QUOTATION
```
    See Also:
    
    Listener.beginQuotation(java.util.Map)
  - END_QUOTATION
```
public static final EventType END_QUOTATION
```
    See Also:
    
    Listener.endQuotation(java.util.Map)
  - BEGIN_QUOTATION_LINE
```
public static final EventType BEGIN_QUOTATION_LINE
```
    See Also:
    
    Listener.beginQuotationLine()
  - END_QUOTATION_LINE
```
public static final EventType END_QUOTATION_LINE
```
    See Also:
    
    Listener.endQuotationLine()
  - BEGIN_SECTION
```
public static final EventType BEGIN_SECTION
```
    See Also:
    
    Listener.beginSection(java.util.Map)
  - END_SECTION
```
public static final EventType END_SECTION
```
    See Also:
    
    Listener.endSection(java.util.Map)
  - BEGIN_TABLE
```
public static final EventType BEGIN_TABLE
```
    See Also:
    
    Listener.beginTable(java.util.Map)
  - END_TABLE
```
public static final EventType END_TABLE
```
    See Also:
    
    Listener.endTable(java.util.Map)
  - BEGIN_TABLE_CELL
```
public static final EventType BEGIN_TABLE_CELL
```
    See Also:
    
    Listener.beginTableCell(java.util.Map)
  - END_TABLE_CELL
```
public static final EventType END_TABLE_CELL
```
    See Also:
    
    Listener.endTableCell(java.util.Map)
  - BEGIN_TABLE_HEAD_CELL
```
public static final EventType BEGIN_TABLE_HEAD_CELL
```
    See Also:
    
    Listener.beginTableHeadCell(java.util.Map)
  - END_TABLE_HEAD_CELL
```
public static final EventType END_TABLE_HEAD_CELL
```
    See Also:
    
    Listener.endTableHeadCell(java.util.Map)
  - BEGIN_TABLE_ROW
```
public static final EventType BEGIN_TABLE_ROW
```
    See Also:
    
    Listener.beginTableRow(java.util.Map)
  - END_TABLE_ROW
```
public static final EventType END_TABLE_ROW
```
    See Also:
    
    Listener.endTableRow(java.util.Map)
  - BEGIN_METADATA
```
public static final EventType BEGIN_METADATA
```
    See Also:
    
    Listener.beginMetaData(org.xwiki.rendering.listener.MetaData)
  - END_METADATA
```
public static final EventType END_METADATA
```
    See Also:
    
    Listener.endMetaData(org.xwiki.rendering.listener.MetaData)
  - ON_RAW_TEXT
```
public static final EventType ON_RAW_TEXT
```
    See Also:
    
    Listener.onRawText(String, org.xwiki.rendering.syntax.Syntax)
  - ON_EMPTY_LINES
```
public static final EventType ON_EMPTY_LINES
```
    See Also:
    
    Listener.onEmptyLines(int)
  - ON_HORIZONTAL_LINE
```
public static final EventType ON_HORIZONTAL_LINE
```
    See Also:
    
    Listener.onHorizontalLine(java.util.Map)
  - ON_ID
```
public static final EventType ON_ID
```
    See Also:
    
    Listener.onId(String)
  - ON_IMAGE
```
public static final EventType ON_IMAGE
```
    See Also:
    
    ImageListener.onImage(org.xwiki.rendering.listener.reference.ResourceReference, boolean, java.util.Map)
  - ON_MACRO
```
public static final EventType ON_MACRO
```
    See Also:
    
    Listener.onMacro(String, java.util.Map, String, boolean)
  - ON_NEW_LINE
```
public static final EventType ON_NEW_LINE
```
    See Also:
    
    Listener.onNewLine()
  - ON_SPACE
```
public static final EventType ON_SPACE
```
    See Also:
    
    Listener.onSpace()
  - ON_SPECIAL_SYMBOL
```
public static final EventType ON_SPECIAL_SYMBOL
```
    See Also:
    
    Listener.onSpecialSymbol(char)
  - ON_VERBATIM
```
public static final EventType ON_VERBATIM
```
    See Also:
    
    Listener.onVerbatim(String, boolean, java.util.Map)
  - ON_WORD
```
public static final EventType ON_WORD
```
    See Also:
    
    Listener.onWord(String)
  - BEGIN_FIGURE
```
public static final EventType BEGIN_FIGURE
```
    See Also:
    
    Listener.beginFigure(Map)
  - BEGIN_FIGURE_CAPTION
```
public static final EventType BEGIN_FIGURE_CAPTION
```
    See Also:
    
    Listener.beginFigureCaption(Map)
  - END_FIGURE
```
public static final EventType END_FIGURE
```
    See Also:
    
    Listener.endFigure(Map)
  - END_FIGURE_CAPTION
```
public static final EventType END_FIGURE_CAPTION
```
    See Also:
    
    Listener.endFigureCaption(Map)
- 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(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
  - fireEvent
```
public abstract void fireEvent(Listener listener,
                               Object... eventParameters)
```
    Calls an event method on the passed listener with the passed parameters.
    
    Parameters:
    
    listener - the listener to call
    
    eventParameters - the parameters to use when calling the event method on the passed listener
  - isInlineEnd
```
public boolean isInlineEnd()
```
    Returns:
    
    true if the event stops the inline mode or false otherwise

Enum EventType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BEGIN_DOCUMENT

END_DOCUMENT

BEGIN_GROUP

END_GROUP

BEGIN_PARAGRAPH

END_PARAGRAPH

BEGIN_DEFINITION_LIST

END_DEFINITION_LIST

BEGIN_DEFINITION_TERM

END_DEFINITION_TERM

BEGIN_DEFINITION_DESCRIPTION

END_DEFINITION_DESCRIPTION

BEGIN_FORMAT

END_FORMAT

BEGIN_HEADER

END_HEADER

BEGIN_LINK

END_LINK

BEGIN_LIST

END_LIST

BEGIN_LIST_ITEM

END_LIST_ITEM

BEGIN_MACRO_MARKER

END_MACRO_MARKER

BEGIN_QUOTATION

END_QUOTATION

BEGIN_QUOTATION_LINE

END_QUOTATION_LINE

BEGIN_SECTION

END_SECTION

BEGIN_TABLE

END_TABLE

BEGIN_TABLE_CELL

END_TABLE_CELL

BEGIN_TABLE_HEAD_CELL

END_TABLE_HEAD_CELL

BEGIN_TABLE_ROW

END_TABLE_ROW

BEGIN_METADATA

END_METADATA

ON_RAW_TEXT

ON_EMPTY_LINES

ON_HORIZONTAL_LINE

ON_ID

ON_IMAGE

ON_MACRO

ON_NEW_LINE

ON_SPACE

ON_SPECIAL_SYMBOL

ON_VERBATIM

ON_WORD

BEGIN_FIGURE

BEGIN_FIGURE_CAPTION

END_FIGURE

END_FIGURE_CAPTION

Method Detail

values

valueOf

fireEvent

isInlineEnd