Cell Annotations

OpenOffice.org Developer's Guide

Spreadsheet Documents

< Previous Section

Next Section >

• Example: Adding a New Spreadsheet
• Example: Editing Spreadsheet Cells

• Handling Spreadsheet Documents Files

• Saving Spreadsheet Documents

• Filter Options

• Printing Spreadsheet Documents

• Working With Spreadsheet Documents

• Spreadsheet Services - Overview

• Capabilities of Spreadsheet
• Capabilities of SheetCellRange
• Capabilities of SheetCell
• Capabilities of SheetCellRanges Container
• Capabilities of Columns and Rows

• Spreadsheet
• Cell Ranges

• Properties of Cell Ranges
• Cell and Cell Range Access
• Merging Cell Ranges into a Single Cell
• Column and Row Access
• Data Array
• Absolute Address
• Fill Series
• Operations
• Multiple Operations
• Handling Array Formulas

• Cells

• Properties of SheetCell
• Access to Formulas, Values and Errors
• Access to Text Content
• Absolute Address
• Cell Annotations

• Cell Ranges and Cells Container
• Columns and Rows

• Formatting

• Character and Paragraph Format
• Indentation
• Equally Formatted Cell Ranges
• Table Auto Formats
• Conditional Formats

• Navigating

• Cell Cursor
• Referencing Ranges by Name
• Named Ranges
• Label Ranges
• Querying for Cells with Specific Properties
• Search and Replace

• Sorting
• Database Operations

• Filtering
• Subtotals
• Database Import
• Database Ranges

• Linking External Data

• Sheet Links
• Cell Area Links
• DDE Links

• DataPilot Tables

• Creating a New DataPilot Table
• Modifying a DataPilot Table
• Removing a DataPilot Table

• DataPilot Sources

• Source Object
• Dimensions
• Hierarchies
• Levels
• Members

• Protecting Spreadsheets
• Sheet Outline
• Detective
• Other Table Operations

• Overall Document Features

• Function Handling
• Settings

• Spreadsheet Document Controller

• View Panes
• View Settings
• Range Selection

• Spreadsheet Add-Ins

• Function Descriptions
• Service Names
• Compatibility Names
• Custom Functions
• Variable Results

< Previous Page

Next Page >

A spreadsheet cell may contain one annotation that consists of simple unformatted Text.

Cell annotations

This service com.sun.star.sheet.CellAnnotation represents an annotation. It implements interfaces to manipulate the contents and access the source cell.

• The interface com.sun.star.sheet.XSheetAnnotation implements methods to query data of the annotation and to show and hide it. This interface is returned by the method getAnnotation() of the interface com.sun.star.sheet.XSheetAnnotationAnchor.
• The method getParent() of the interface com.sun.star.container.XChild returns the cell object that contains the annotation.
• The interface com.sun.star.text.XSimpleText modifies the text contents of the annotation. See Editing Text for details.

It is possible to access the annotations through a container object from the spreadsheet or directly from a cell object.

• The method getAnnotations() of the interface com.sun.star.sheet.XSheetAnnotationsSupplier returns the interface com.sun.star.sheet.XSheetAnnotations of the annotations collection of this spreadsheet.
• The method getAnnotation() of the interface com.sun.star.sheet.XSheetAnnotationAnchor returns the interface com.sun.star.sheet.XSheetAnnotation of an annotation object.

The service com.sun.star.sheet.CellAnnotations represents the collection of annotations for the spreadsheet and implements two interfaces to access the annotations.

• The interface com.sun.star.sheet.XSheetAnnotations is derived from com.sun.star.container.XIndexAccess to access and remove annotations through their index. The method insertNew() attaches a new annotation to a cell.
• The method createEnumeration() of the interface com.sun.star.container.XEnumerationAccess creates an enumeration object, represented by the service com.sun.star.sheet.CellAnnotationsEnumeration, to access the annotations sequentially.

The following example inserts an annotation and makes it permanently visible.

 public void doAnnotationSample(
         com.sun.star.sheet.XSpreadsheet xSheet,
         int nColumn, int nRow ) throws RuntimeException, Exception {
     // create the CellAddress struct
     com.sun.star.table.XCell xCell = xSheet.getCellByPosition(nColumn, nRow);
     com.sun.star.sheet.XCellAddressable xCellAddr = (com.sun.star.sheet.XCellAddressable)
         UnoRuntime.queryInterface(com.sun.star.sheet.XCellAddressable.class, xCell);
     com.sun.star.table.CellAddress aAddress = xCellAddr.getCellAddress();
   
     // insert an annotation
     com.sun.star.sheet.XSheetAnnotationsSupplier xAnnotationsSupp =
         (com.sun.star.sheet.XSheetAnnotationsSupplier) UnoRuntime.queryInterface(
             com.sun.star.sheet.XSheetAnnotationsSupplier.class, xSheet);
     com.sun.star.sheet.XSheetAnnotations xAnnotations = xAnnotationsSupp.getAnnotations();
     xAnnotations.insertNew(aAddress, "This is an annotation");
 
     // make the annotation visible
     com.sun.star.sheet.XSheetAnnotationAnchor xAnnotAnchor =
         (com.sun.star.sheet.XSheetAnnotationAnchor) UnoRuntime.queryInterface(
             com.sun.star.sheet.XSheetAnnotationAnchor.class, xCell);
     com.sun.star.sheet.XSheetAnnotation xAnnotation = xAnnotAnchor.getAnnotation();
     xAnnotation.setIsVisible(true);
 }

Content on this page is licensed under the Public Documentation License (PDL).