Top Description Methods
org.apache.poi.sl.usermodel

public Interface HighlightColorSupport

Annotations
@SuppressWarnings:unused, java:S1452
Imports
java.awt.Color, org.apache.poi.common.usermodel.fonts.FontGroup, .FontInfo, org.apache.poi.sl.usermodel.PaintStyle.SolidPaint, org.apache.poi.util.Internal
An interface to provide support for get/set of highlight color in XLSFTextRuns instances. Spec Ref: 21.1.2.3.4 (ECMA-376-1 5th ed. Ecma Office Open XML Part 1 - Fundamentals And Markup Language Reference.pdf)
Since
POI 5.2.4

Method Summary

Modifier and TypeMethod and Description
public PaintStyle

Returns:

The font highlight (background) colour associated with the run, null if no highlight.
getHighlightColor()

Returns the font highlight (background) color for this text run.

public void
setHighlightColor(final PaintStyle
The highlight (background) color to set.
color)

Set the highlight (background) color for this text run.

public void
setHighlightColor(final Color
The highlight (background) color to set.
color)

Sets the font highlight (background) color for this text run - convenience function

Method Detail

getHighlightColorback to summary
public PaintStyle getHighlightColor()

Returns the font highlight (background) color for this text run. This returns a SolidPaint, or null if no highlight is set.

Returns:PaintStyle

The font highlight (background) colour associated with the run, null if no highlight.

Since
POI 5.2.4
See Also
org.apache.poi.sl.draw.DrawPaint#getPaint(java.awt.Graphics2D, PaintStyle), SolidPaint#getSolidColor()
setHighlightColorback to summary
public void setHighlightColor(final PaintStyle color)

Set the highlight (background) color for this text run.

Parameters
color:PaintStyle

The highlight (background) color to set.

Since
POI 5.2.4
See Also
org.apache.poi.sl.draw.DrawPaint#createSolidPaint(Color)
setHighlightColorback to summary
public void setHighlightColor(final Color color)

Sets the font highlight (background) color for this text run - convenience function

Parameters
color:Color

The highlight (background) color to set.

Since
POI 5.2.4