org.apache.poi.sl.usermodel

Interface HighlightColorSupport

public interface HighlightColorSupport

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 Type	Method and Description
PaintStyle	getHighlightColor() Returns the font highlight (background) color for this text run.
void	setHighlightColor(Color color) Sets the font highlight (background) color for this text run - convenience function
void	setHighlightColor(PaintStyle color) Set the highlight (background) color for this text run.

Method Detail

getHighlightColor

PaintStyle getHighlightColor()

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

Returns:

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

Since:

POI 5.2.4

See Also:

DrawPaint.getPaint(java.awt.Graphics2D, PaintStyle), PaintStyle.SolidPaint.getSolidColor()

setHighlightColor

void setHighlightColor(PaintStyle color)

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

Parameters:

color - The highlight (background) color to set.

Since:

POI 5.2.4

See Also:

DrawPaint.createSolidPaint(Color)

setHighlightColor

void setHighlightColor(Color color)

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

Parameters:

color - The highlight (background) color to set.

Since:

POI 5.2.4