@API(type=NOT_EXTENDABLE,
src=PUBLIC)
public interface Highlight
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
HOVER_ACTIONS_PROVIDER_ADDITIONAL_DATA
Key for the menu creator getting the actions that can be performed over the highlight,
as well as information about rendering.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getAdditionalData() |
java.lang.Object |
getAdditionalData(java.lang.String key)
Gets the additional data for the given key.
|
int |
getEndOffset()
Gets the ending model offset for the highlight.
|
HighlightPainter |
getPainter()
Gets the painter for the highlighter.
|
int |
getStartOffset()
Gets the starting model offset for the highlight.
|
void |
setAdditionalData(java.lang.String key,
java.lang.Object additionalData)
Sets the additional data for the given key.
|
static final java.lang.String HOVER_ACTIONS_PROVIDER_ADDITIONAL_DATA
HighlightActionsProvider
int getStartOffset()
int getEndOffset()
java.lang.Object getAdditionalData()
java.lang.Object getAdditionalData(java.lang.String key)
key
- the key for which the additional data is to be retrieved.
The key HOVER_ACTIONS_PROVIDER_ADDITIONAL_DATA
can be used in order to get
the HighlightActionsProvider
object, providing a set of actions and some rendering information.
This can be used to display a widget when hovering over the highlight, from which the provided actions can be performed.Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
void setAdditionalData(java.lang.String key, java.lang.Object additionalData)
key
- The key for which the additional data is set.HOVER_ACTIONS_PROVIDER_ADDITIONAL_DATA
can be used in order to set
an actions provider for the highlight, containing a set of actions, as well as some information about their rendering.
The goal is to display a widget when hovering over the highlight, from which the provided actions can be performed.additionalData
- The additional data to set.HOVER_ACTIONS_PROVIDER_ADDITIONAL_DATA
key,
the value must be a HighlightActionsProvider
.Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
HighlightPainter getPainter()
© Copyright SyncRO Soft SRL 2002 - 2015. All rights reserved.