org.eclipse.stardust.engine.extensions.dms.data.annotations.printdocument
Interface HighlightCapable

All Known Subinterfaces:
PrintDocumentAnnotations

public interface HighlightCapable


Method Summary
 void addAllHighlights(Set<Highlight> highlights)
          Adds the given set of highlights to the stored ones.
 void addHighlight(Highlight highlight)
          Adds the Highlight.
 Highlight getHighlight(String id)
           
 Set<Highlight> getHighlights()
           
 void removeAllHighlights()
          Removes all highlights.
 void removeHighlight(String id)
           
 void setHighlights(Set<Highlight> hightlights)
          Replaces the stored highlights with the given set.
 

Method Detail

addHighlight

void addHighlight(Highlight highlight)
Adds the Highlight.

Parameters:
highlight -
Throws:
org.eclipse.stardust.common.error.InvalidArgumentException - if the id of the Highlight already exists.

getHighlight

Highlight getHighlight(String id)

getHighlights

Set<Highlight> getHighlights()

removeHighlight

void removeHighlight(String id)

setHighlights

void setHighlights(Set<Highlight> hightlights)
Replaces the stored highlights with the given set.

Parameters:
hightlights -
Throws:
org.eclipse.stardust.common.error.InvalidArgumentException - if the given set contains more than one element with the same Identifiable#id.

addAllHighlights

void addAllHighlights(Set<Highlight> highlights)
Adds the given set of highlights to the stored ones.

Parameters:
highlights -
Throws:
org.eclipse.stardust.common.error.InvalidArgumentException - if the given set contains more than one element with the same Identifiable#id.
org.eclipse.stardust.common.error.InvalidArgumentException - if the set contains at least one highlight with the same Identifiable#id as a stored highlight.

removeAllHighlights

void removeAllHighlights()
Removes all highlights.



Copyright © 2017 Eclipse Stardust. All Rights Reserved.