Top Description Methods
org.apache.poi.ss.usermodel

public Interface Header

extends HeaderFooter
Known Direct Implementers
org.apache.poi.hssf.usermodel.HSSFHeader
Common definition of a HSSF or XSSF page header. For a list of all the different fields that can be placed into a header, such as page number, bold, underline etc, see org.apache.poi.ss.usermodel.HeaderFooter.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The string representing the center.
getCenter()

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.getCenter.

Get the center of the header.

public String

Returns:

The string representing the left side.
getLeft()

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.getLeft.

Get the left side of the header.

public String

Returns:

The string representing the right side.
getRight()

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.getRight.

Get the right side of the header.

public void
setCenter(String
The string to set as the center.
newCenter)

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.setCenter.

Sets the center string.

public void
setLeft(String
The string to set as the left side.
newLeft)

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.setLeft.

Sets the left string.

public void
setRight(String
The string to set as the right side.
newRight)

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.setRight.

Sets the right string.

Method Detail

getCenterback to summary
public String getCenter()

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.getCenter.

Get the center of the header.

Returns:String

The string representing the center.

getLeftback to summary
public String getLeft()

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.getLeft.

Get the left side of the header.

Returns:String

The string representing the left side.

getRightback to summary
public String getRight()

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.getRight.

Get the right side of the header.

Returns:String

The string representing the right side.

setCenterback to summary
public void setCenter(String newCenter)

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.setCenter.

Sets the center string.

Parameters
newCenter:String

The string to set as the center.

setLeftback to summary
public void setLeft(String newLeft)

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.setLeft.

Sets the left string.

Parameters
newLeft:String

The string to set as the left side.

setRightback to summary
public void setRight(String newRight)

Redeclares org.apache.poi.ss.usermodel.HeaderFooter.setRight.

Sets the right string.

Parameters
newRight:String

The string to set as the right side.