ResultsTabEvent (Oxygen XML API)

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface ResultsTabEvent

An event triggered inside a results tab.

Since:: 19.0

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class ResultsTabEvent.ResultsTabEventType
The type of the event from the results tab.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ResultsTabEvent.ResultsTabEventType`	`getEventType()`	Gets the event type.
`DocumentPositionedInfo`	`getResultItem()`	Gets the result from the results tab for which the event was triggered.
`java.lang.String`	`getTabKey()`	Gets the key identifying the tab where the event was triggered.

- Method Detail
  - getTabKey
```
java.lang.String getTabKey()
```
    Gets the key identifying the tab where the event was triggered.
    
    Returns:
    
    Returns the key identifying the tab where the event was triggered.
  - getResultItem
```
DocumentPositionedInfo getResultItem()
```
    Gets the result from the results tab for which the event was triggered.
    
    Returns:
    
    Returns the result for which the event was triggered.
  - getEventType
```
ResultsTabEvent.ResultsTabEventType getEventType()
```
    Gets the event type. One of the values defined in ResultsTabEvent.ResultsTabEventType.
    
    Returns:
    
    Returns the event type.