com.intechcore.scomponents.scell.api.spreadsheet.service

Interface IStyleService

public interface IStyleService

Represents a cell style service used to set or change the properties of the cell style

Method Summary

Modifier and Type	Method and Description
void	clear(IRangeAddress range) Clears the style in the range of cells
void	clearHighlighting() Clears highlighting for all cells
void	clearHighlighting(IRangeAddress range) Clears highlighting for given range
void	highlight(IRangeAddress range, Consumer<IStyleBuilder> builderConsumer) Highlights a range of cells.
void	highlight(IRangeAddress range, IStyle style) Highlights a range of cells.
void	set(int colNum, int rowNum, IStyle style) Sets the style in the single cell.
void	set(IRangeAddress range, Consumer<IStyleBuilder> builderConsumer) Sets the font in the range of cells.
void	set(IRangeAddress range, IStyle style) Sets the style in the range of cells
void	set(String range, IStyle style) Sets the style to range of cells with the given String with values like "A4" or "D4:G10"
void	updateCommon(IRangeAddress range, Consumer<IStyleBuilder> builderConsumer) Edits a common style in the range.
void	updateCommon(IRangeAddress range, UnaryOperator<IStyle> editor) Edit a common style in the range.
void	updateEach(IRangeAddress range, Consumer<IStyleBuilder> builderConsumer) Edits the style of each cell in the given range.
void	updateEach(IRangeAddress range, UnaryOperator<IStyle> editor) Edits the style of each cell in the given range.

Method Detail

updateCommon

void updateCommon(IRangeAddress range,
                  UnaryOperator<IStyle> editor)

Edit a common style in the range. Allows to apply the properties of the style to the selected range of cells.

'Common' means here the following: the value of each attribute of the style is not null when all cells from the selected area have the same value of the attribute. The value of the attribute is null when the style properties of a cell or cells are different from the properties of the other cells in the range

Edit only the attributes that are not null. Otherwise, use the updateCommon(IRangeAddress, Consumer) which is more convenient

Parameters:

range - the IRangeAddress in which the settings will be applied

editor - the function which takes the current common style and produces the new style to be applied

See Also:

UnaryOperator, IStyle

updateCommon

void updateCommon(IRangeAddress range,
                  Consumer<IStyleBuilder> builderConsumer)

Edits a common style in the range. For convenience, the method gives the IStyleBuilder with the current properties of the common style. The function calls IStyleBuilder.build() and then updateCommon(IRangeAddress, UnaryOperator)

Parameters:

range - the IRangeAddress in which the settings will be applied

builderConsumer - the function which takes IStyleBuilder filled with the current properties of the common style

See Also:

Consumer, IStyle

updateEach

void updateEach(IRangeAddress range,
                UnaryOperator<IStyle> editor)

Edits the style of each cell in the given range. Applies the properties of the style to the selected range of cells.

Parameters:

range - the IRangeAddress in which the settings will be applied

editor - the function which takes the current common style and produces the new style to be applied

See Also:

UnaryOperator, IStyle

updateEach

void updateEach(IRangeAddress range,
                Consumer<IStyleBuilder> builderConsumer)

Edits the style of each cell in the given range. Applies the properties of the style to the selected range of cells.

Parameters:

range - the IRangeAddress in which the settings will be applied

builderConsumer - the function which takes IStyleBuilder filled with the current properties of the common style

See Also:

Consumer, IStyle

set

void set(int colNum,
         int rowNum,
         IStyle style)

Sets the style in the single cell.

In the case of incorrect row/column numbers the IndexOutOfBoundsException will be thrown

Parameters:

colNum - the column number

rowNum - the row number

style - the style to set

set

void set(String range,
         IStyle style)

Sets the style to range of cells with the given String with values like "A4" or "D4:G10"

In the case of the incorrect string value the ParseRangeAddressException will be thrown

Parameters:

range - the cells range

style - the value

See Also:

IStyle

set

void set(IRangeAddress range,
         IStyle style)

Sets the style in the range of cells

Parameters:

range - the IRangeAddress in which the settings will be applied

style - the style to be set

See Also:

IRangeAddress, IStyle

set

void set(IRangeAddress range,
         Consumer<IStyleBuilder> builderConsumer)

Sets the font in the range of cells. For convenience, the user consumes a new instance of the IStyleBuilder into which the desired values will be filled in. The builder is instantiated from the IScellApiResolver so that the user could register his own implementation using custom default data. The function calls IStyleBuilder.build() and set(IRangeAddress, IStyle) with the obtained data result

Parameters:

range - the IRangeAddress in which the settings will be applied

builderConsumer - the Consumer with a new instance of IStyleBuilder

See Also:

IRangeAddress, IStyle

clear

void clear(IRangeAddress range)

Clears the style in the range of cells

Parameters:

range - the IRangeAddress in which the clearing will be applied

See Also:

IRangeAddress

highlight

void highlight(IRangeAddress range,
               Consumer<IStyleBuilder> builderConsumer)

Highlights a range of cells.

Parameters:

range - the IRangeAddress in which the highlighted style will be applied

builderConsumer - the Consumer with a new instance of IStyleBuilder

See Also:

IRangeAddress, IStyleBuilder

highlight

void highlight(IRangeAddress range,
               IStyle style)

Highlights a range of cells.

Parameters:

range - the IRangeAddress in which the highlighted style will be applied

style - the style of highlight

See Also:

IRangeAddress, IStyle

clearHighlighting

void clearHighlighting()

Clears highlighting for all cells

clearHighlighting

void clearHighlighting(IRangeAddress range)

Clears highlighting for given range

Parameters:

range - range to clear highlighting