86 lines
2.6 KiB
Java
86 lines
2.6 KiB
Java
/* ====================================================================
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
(the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
==================================================================== */
|
|
|
|
package org.apache.poi.ss.usermodel;
|
|
|
|
|
|
public interface Comment {
|
|
|
|
/**
|
|
* Returns whether this comment is visible.
|
|
*
|
|
* @param visible <code>true</code> if the comment is visible, <code>false</code> otherwise
|
|
*/
|
|
void setVisible(boolean visible);
|
|
|
|
/**
|
|
* Sets whether this comment is visible.
|
|
*
|
|
* @return <code>true</code> if the comment is visible, <code>false</code> otherwise
|
|
*/
|
|
boolean isVisible();
|
|
|
|
/**
|
|
* Return the row of the cell that contains the comment
|
|
*
|
|
* @return the 0-based row of the cell that contains the comment
|
|
*/
|
|
int getRow();
|
|
|
|
/**
|
|
* Set the row of the cell that contains the comment
|
|
*
|
|
* @param row the 0-based row of the cell that contains the comment
|
|
*/
|
|
void setRow(int row);
|
|
|
|
/**
|
|
* Return the column of the cell that contains the comment
|
|
*
|
|
* @return the 0-based column of the cell that contains the comment
|
|
*/
|
|
short getColumn();
|
|
|
|
/**
|
|
* Set the column of the cell that contains the comment
|
|
*
|
|
* @param col the 0-based column of the cell that contains the comment
|
|
*/
|
|
void setColumn(short col);
|
|
|
|
/**
|
|
* Name of the original comment author
|
|
*
|
|
* @return the name of the original author of the comment
|
|
*/
|
|
String getAuthor();
|
|
|
|
/**
|
|
* Name of the original comment author
|
|
*
|
|
* @param author the name of the original author of the comment
|
|
*/
|
|
void setAuthor(String author);
|
|
|
|
/**
|
|
* Sets the rich text string used by this comment.
|
|
*
|
|
* @param string Sets the rich text string used by this object.
|
|
*/
|
|
void setString(RichTextString string);
|
|
|
|
} |