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

Interface ICommentService

public interface ICommentService

Represents a comment service interface

Method Summary

Modifier and Type	Method and Description
void	clear(IRangeAddress range) Removes all comments in given range
void	set(IRangeAddress range, Consumer<ICommentBuilder> builderConsumer) Sets the comments in the given range address.
void	set(IRangeAddress range, IComment comment) Sets comments to all cells in the given range
void	updateExisting(IRangeAddress range, AddressItemEditor<IComment> editor) Edits comments in the given range.

Method Detail

set

void set(IRangeAddress range,
         IComment comment)

Sets comments to all cells in the given range

Parameters:

range - the IRangeAddress to which the comment will be added

comment - the comment to be added

See Also:

IComment, IRangeAddress

set

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

Sets the comments in the given range address. For convenience, the user consumes a new instance of the ICommentBuilder 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. This function calls ICommentBuilder.build() and set(IRangeAddress, IComment) with the obtained data result

Parameters:

range - the IRangeAddress to which the comment will be added

builderConsumer - the Consumer with a new instance of ICommentBuilder

See Also:

IComment, IRangeAddress

updateExisting

void updateExisting(IRangeAddress range,
                    AddressItemEditor<IComment> editor)

Edits comments in the given range. Calls the editor function for each cell (with or without the existing comment) in the range

Parameters:

range - the IRangeAddress to which the comment will be added

editor - the function that gets the current cell comments and produces the new ones. If the editor returns null, the existing comment will be removed. It can throw the InterruptEditOperation to interrupt the operation

See Also:

IRangeAddress, IComment

clear

void clear(IRangeAddress range)

Removes all comments in given range

Parameters:

range - the IRangeAddress in which the comments will be removed