org.apache.poi.ss.util
Class DataMarker

java.lang.Object
  extended by org.apache.poi.ss.util.DataMarker

public class DataMarker
extends java.lang.Object

Represents data marker used in charts.

Author:
Roman Kashitsyn

Constructor Summary
DataMarker(Sheet sheet, CellRangeAddress range)
           
 
Method Summary
 java.lang.String formatAsString()
          Formats data marker using canonical format, for example `SheetName!$A$1:$A$5'.
 CellRangeAddress getRange()
          Returns range of the marker.
 Sheet getSheet()
          Returns the sheet marker points to.
 void setRange(CellRangeAddress range)
          Sets range of the marker.
 void setSheet(Sheet sheet)
          Sets sheet marker points to.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataMarker

public DataMarker(Sheet sheet,
                  CellRangeAddress range)
Parameters:
sheet - the sheet where data located.
range - the range within that sheet.
Method Detail

getSheet

public Sheet getSheet()
Returns the sheet marker points to.

Returns:
sheet marker points to.

setSheet

public void setSheet(Sheet sheet)
Sets sheet marker points to.

Parameters:
sheet - new sheet for the marker.

getRange

public CellRangeAddress getRange()
Returns range of the marker.

Returns:
range of cells marker points to.

setRange

public void setRange(CellRangeAddress range)
Sets range of the marker.

Parameters:
range - new range for the marker.

formatAsString

public java.lang.String formatAsString()
Formats data marker using canonical format, for example `SheetName!$A$1:$A$5'.

Returns:
formatted data marker.


Copyright 2011 The Apache Software Foundation or its licensors, as applicable.