org.apache.poi.hssf.usermodel
Class HSSFName

java.lang.Object
  extended by org.apache.poi.hssf.usermodel.HSSFName

public final class HSSFName
extends java.lang.Object

High Level Representation of a 'defined name' which could be a 'built-in' name, 'named range' or name of a user defined function.

Author:
Libin Roman (Vista Portal LDT. Developer)

Method Summary
 java.lang.String getNameName()
           
 java.lang.String getReference()
          Note - this method only applies to named ranges
 java.lang.String getSheetName()
          Get the sheets name which this named range is referenced to
 boolean isDeleted()
          Tests if this name points to a cell that no longer exists
 boolean isFunctionName()
           
 void setNameName(java.lang.String nameName)
          sets the name of the named range
 void setReference(java.lang.String ref)
          sets the reference of this named range
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getSheetName

public java.lang.String getSheetName()
Get the sheets name which this named range is referenced to

Returns:
sheet name, which this named range referred to

getNameName

public java.lang.String getNameName()
Returns:
text name of this defined name

setNameName

public void setNameName(java.lang.String nameName)
sets the name of the named range

Parameters:
nameName - named range name to set

getReference

public java.lang.String getReference()
Note - this method only applies to named ranges

Returns:
the formula text defining the named range

setReference

public void setReference(java.lang.String ref)
sets the reference of this named range

Parameters:
ref - the reference to set

isDeleted

public boolean isDeleted()
Tests if this name points to a cell that no longer exists

Returns:
true if the name refers to a deleted cell, false otherwise

isFunctionName

public boolean isFunctionName()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


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