XSSFHyperlink (POI API Documentation)

java.lang.Object
- org.apache.poi.xssf.usermodel.XSSFHyperlink

All Implemented Interfaces:

Hyperlink
```
public class XSSFHyperlink
extends java.lang.Object
implements Hyperlink
```
XSSF Implementation of a Hyperlink. Note - unlike with HSSF, many kinds of hyperlink are largely stored as relations of the sheet (超链接的 XSSF 实现。注意 - 与 HSSF 不同，多种超链接主要存储为工作表的关系)

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`XSSFHyperlink(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHyperlink ctHyperlink, PackageRelationship hyperlinkRel)` Create a XSSFHyperlink and initialize it from the supplied CTHyperlink bean and package relationship (创建一个 XSSFHyperlink 并从提供的 CTHyperlink bean 和包关系初始化它)
	`XSSFHyperlink(Hyperlink other)` Create a new XSSFHyperlink. (创建一个新的 XSSFHyperlink。)
`protected`	`XSSFHyperlink(HyperlinkType type)` Create a new XSSFHyperlink. (创建一个新的 XSSFHyperlink。)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`generateRelationIfNeeded(PackagePart sheetPart)` Generates the relation if required (如果需要，生成关系)
`java.lang.String`	`getAddress()` Hyperlink address. (超链接地址。)
`java.lang.String`	`getCellRef()` Get the address of the cell this hyperlink applies to, e.g. (获取此超链接适用的单元格的地址，例如)
`org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHyperlink`	`getCTHyperlink()`
`int`	`getFirstColumn()` Return the column of the first cell that contains the hyperlink (返回包含超链接的第一个单元格的列)
`int`	`getFirstRow()` Return the row of the first cell that contains the hyperlink (返回包含超链接的第一个单元格的行)
`java.lang.String`	`getLabel()` Return text label for this hyperlink (返回此超链接的文本标签)
`int`	`getLastColumn()` Return the column of the last cell that contains the hyperlink (返回包含超链接的最后一个单元格的列)
`int`	`getLastRow()` Return the row of the last cell that contains the hyperlink (返回包含超链接的最后一个单元格的行)
`java.lang.String`	`getLocation()` Location within target. (目标内的位置。)
`java.lang.String`	`getTooltip()`
`HyperlinkType`	`getType()` Return the type of this hyperlink (返回此超链接的类型)
`boolean`	`needsRelationToo()` Do we need to a relation too, to represent this hyperlink? (我们是否也需要一个关系来表示这个超链接？)
`void`	`setAddress(java.lang.String address)` Hyperlink address. (超链接地址。)
`void`	`setCellReference(CellReference ref)`
`void`	`setCellReference(java.lang.String ref)` Assigns this hyperlink to the given cell reference (将此超链接分配给给定的单元格引用)
`void`	`setFirstColumn(int col)` Set the column of the first cell that contains the hyperlink (设置包含超链接的第一个单元格的列)
`void`	`setFirstRow(int row)` Set the row of the first cell that contains the hyperlink (设置包含超链接的第一个单元格的行)
`void`	`setLabel(java.lang.String label)` Sets text label for this hyperlink (设置此超链接的文本标签)
`void`	`setLastColumn(int col)` Set the column of the last cell that contains the hyperlink. (设置包含超链接的最后一个单元格的列。)
`void`	`setLastRow(int row)` Set the row of the last cell that contains the hyperlink. (设置包含超链接的最后一个单元格的行。)
`void`	`setLocation(java.lang.String location)` Location within target. (目标内的位置。)
`void`	`setTooltip(java.lang.String text)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XSSFHyperlink
```
protected XSSFHyperlink(HyperlinkType type)
```
    Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper.createHyperlink(HyperlinkType). (创建一个新的 XSSFHyperlink。此方法受保护，仅供 XSSFCreationHelper.createHyperlink(HyperlinkType) 使用。)
    
    Parameters:
    
    type - - the type of hyperlink to create (type - - 要创建的超链接的类型)
  - XSSFHyperlink
```
protected XSSFHyperlink(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHyperlink ctHyperlink,
                        PackageRelationship hyperlinkRel)
```
    Create a XSSFHyperlink and initialize it from the supplied CTHyperlink bean and package relationship (创建一个 XSSFHyperlink 并从提供的 CTHyperlink bean 和包关系初始化它)
    
    Parameters:
    
    ctHyperlink - the xml bean containing xml properties (ctHyperlink - 包含 xml 属性的 xml bean)
    
    hyperlinkRel - the relationship in the underlying OPC package which stores the actual link's address (hyperlinkRel - 底层 OPC 包中存储实际链接地址的关系)
  - XSSFHyperlink
```
@Internal
public XSSFHyperlink(Hyperlink other)
```
    Create a new XSSFHyperlink. This method is for Internal use only. XSSFHyperlinks can be created by XSSFCreationHelper. See the spreadsheet quick-guide for an example. (创建一个新的 XSSFHyperlink。此方法仅供内部使用。 XSSFCreationHelper 可以创建 XSSF 超链接。有关示例，请参阅电子表格快速指南。)
    
    Parameters:
    
    other - the hyperlink to copy (other - 要复制的超链接)
- Method Detail
  - getCTHyperlink
```
@Internal
public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTHyperlink getCTHyperlink()
```
    Returns:
    
    the underlying CTHyperlink object (底层 CTHyperlink 对象)
  - needsRelationToo
```
public boolean needsRelationToo()
```
    Do we need to a relation too, to represent this hyperlink? (我们是否也需要一个关系来表示这个超链接？)
  - generateRelationIfNeeded
```
protected void generateRelationIfNeeded(PackagePart sheetPart)
```
    Generates the relation if required (如果需要，生成关系)
  - getType
```
public HyperlinkType getType()
```
    Return the type of this hyperlink (返回此超链接的类型)
    
    Specified by:
    
    getType in interface Hyperlink (接口 Hyperlink 中的 getType)
    
    Returns:
    
    the type of this hyperlink (此超链接的类型)
  - getCellRef
```
public java.lang.String getCellRef()
```
    Get the address of the cell this hyperlink applies to, e.g. A55 (获取此超链接适用的单元格的地址，例如 A55)
  - getAddress
```
public java.lang.String getAddress()
```
    Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file. The is the hyperlink target. (超链接地址。根据超链接类型，它可以是 URL、电子邮件、文件路径。是超链接目标。)
    
    Specified by:
    
    getAddress in interface Hyperlink (接口 Hyperlink 中的 getAddress)
    
    Returns:
    
    the address of this hyperlink (此超链接的地址)
  - getLabel
```
public java.lang.String getLabel()
```
    Return text label for this hyperlink (返回此超链接的文本标签)
    
    Specified by:
    
    getLabel in interface Hyperlink (接口超链接中的getLabel)
    
    Returns:
    
    text to display (要显示的文本)
  - getLocation
```
public java.lang.String getLocation()
```
    Location within target. If target is a workbook (or this workbook) this shall refer to a sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file. (目标内的位置。如果目标是工作簿（或此工作簿），则应引用工作表和单元格或定义的名称。如果目标是 HTML 文件，也可以是 HTML 锚点。)
    
    Returns:
    
    location (地点)
  - setLabel
```
public void setLabel(java.lang.String label)
```
    Sets text label for this hyperlink (设置此超链接的文本标签)
    
    Specified by:
    
    setLabel in interface Hyperlink (界面超链接中的 setLabel)
    
    Parameters:
    
    label - text label for this hyperlink (label - 此超链接的文本标签)
  - setLocation
```
public void setLocation(java.lang.String location)
```
    Location within target. If target is a workbook (or this workbook) this shall refer to a sheet and cell or a defined name. Can also be an HTML anchor if target is HTML file. (目标内的位置。如果目标是工作簿（或此工作簿），则应引用工作表和单元格或定义的名称。如果目标是 HTML 文件，也可以是 HTML 锚点。)
    
    Parameters:
    
    location - - string representing a location of this hyperlink (location - 表示此超链接位置的字符串)
  - setAddress
```
public void setAddress(java.lang.String address)
```
    Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, path to a file This is the hyperlink target. (超链接地址。根据超链接类型，它可以是 URL、电子邮件、文件路径这是超链接目标。)
    
    Specified by:
    
    setAddress in interface Hyperlink (接口超链接中的 setAddress)
    
    Parameters:
    
    address - - the address of this hyperlink (地址——这个超链接的地址)
  - setCellReference
```
@Internal
public void setCellReference(java.lang.String ref)
```
    Assigns this hyperlink to the given cell reference (将此超链接分配给给定的单元格引用)
  - setCellReference
```
@Internal
public void setCellReference(CellReference ref)
```
  - getFirstColumn
```
public int getFirstColumn()
```
    Return the column of the first cell that contains the hyperlink (返回包含超链接的第一个单元格的列)
    
    Returns:
    
    the 0-based column of the first cell that contains the hyperlink (包含超链接的第一个单元格的从 0 开始的列)
  - getLastColumn
```
public int getLastColumn()
```
    Return the column of the last cell that contains the hyperlink (返回包含超链接的最后一个单元格的列)
    
    Returns:
    
    the 0-based column of the last cell that contains the hyperlink (包含超链接的最后一个单元格的从 0 开始的列)
  - getFirstRow
```
public int getFirstRow()
```
    Return the row of the first cell that contains the hyperlink (返回包含超链接的第一个单元格的行)
    
    Returns:
    
    the 0-based row of the cell that contains the hyperlink (包含超链接的单元格的从 0 开始的行)
  - getLastRow
```
public int getLastRow()
```
    Return the row of the last cell that contains the hyperlink (返回包含超链接的最后一个单元格的行)
    
    Returns:
    
    the 0-based row of the last cell that contains the hyperlink (包含超链接的最后一个单元格的从 0 开始的行)
  - setFirstColumn
```
public void setFirstColumn(int col)
```
    Set the column of the first cell that contains the hyperlink (设置包含超链接的第一个单元格的列)
    
    Parameters:
    
    col - the 0-based column of the first cell that contains the hyperlink (col - 包含超链接的第一个单元格的从 0 开始的列)
  - setLastColumn
```
public void setLastColumn(int col)
```
    Set the column of the last cell that contains the hyperlink. For XSSF, a Hyperlink may only reference one cell (设置包含超链接的最后一个单元格的列。对于 XSSF，超链接只能引用一个单元格)
    
    Parameters:
    
    col - the 0-based column of the last cell that contains the hyperlink (col - 包含超链接的最后一个单元格的从 0 开始的列)
  - setFirstRow
```
public void setFirstRow(int row)
```
    Set the row of the first cell that contains the hyperlink (设置包含超链接的第一个单元格的行)
    
    Parameters:
    
    row - the 0-based row of the first cell that contains the hyperlink (row - 包含超链接的第一个单元格的从 0 开始的行)
  - setLastRow
```
public void setLastRow(int row)
```
    Set the row of the last cell that contains the hyperlink. For XSSF, a Hyperlink may only reference one cell (设置包含超链接的最后一个单元格的行。对于 XSSF，超链接只能引用一个单元格)
    
    Parameters:
    
    row - the 0-based row of the last cell that contains the hyperlink (row - 包含超链接的最后一个单元格的从 0 开始的行)
  - getTooltip
```
public java.lang.String getTooltip()
```
    Returns:
    
    additional text to help the user understand more about the hyperlink (附加文本以帮助用户了解有关超链接的更多信息)
  - setTooltip
```
public void setTooltip(java.lang.String text)
```
    Parameters:
    
    text - additional text to help the user understand more about the hyperlink (文本 - 附加文本以帮助用户了解有关超链接的更多信息)

Class XSSFHyperlink

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XSSFHyperlink

XSSFHyperlink

XSSFHyperlink

Method Detail

getCTHyperlink

needsRelationToo

generateRelationIfNeeded

getType

getCellRef

getAddress

getLabel

getLocation

setLabel

setLocation

setAddress

setCellReference

setCellReference

getFirstColumn

getLastColumn

getFirstRow

getLastRow

setFirstColumn

setLastColumn

setFirstRow

setLastRow

getTooltip

setTooltip