Top Inners Methods
org.apache.poi.sl.usermodel

public Interface TableCell<S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>>

extends TextShape<S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>>
Imports
java.awt.Color, org.apache.poi.sl.usermodel.StrokeStyle.LineCompound, .StrokeStyle.LineDash

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
TableCell.BorderEdge

Method Summary

Modifier and TypeMethod and Description
public StrokeStyle

Returns:

line style of given edge or null if border is not defined
getBorderStyle(TableCell.BorderEdge
the border edge
edge)

Return line style of given edge or null if border is not defined

public int

Returns:

the grid span
getGridSpan()

Get the number of columns to be spanned/merged

public int

Returns:

the row span
getRowSpan()

Get the number of rows to be spanned/merged

public boolean

Returns:

true if this a merged cell
isMerged()

Return if this cell is part of a merged cell.

public void
removeBorder(TableCell.BorderEdge
the border edge to be cleared
edge)

Remove all line attributes of the given border edge

public void
setBorderColor(TableCell.BorderEdge
border edge
edge, Color
the new border color
color)

Convenience method for setting the border color.

public void
setBorderCompound(TableCell.BorderEdge
border edge
edge, StrokeStyle.LineCompound
the new border line compound
compound)

Convenience method for setting the border line compound.

public void
setBorderDash(TableCell.BorderEdge
border edge
edge, StrokeStyle.LineDash
the new border line dash
dash)

Convenience method for setting the border line dash.

public void
setBorderStyle(TableCell.BorderEdge
border edge
edge, StrokeStyle
the new stroke style
style)

Sets the StrokeStyle of the given border edge.

public void
setBorderWidth(TableCell.BorderEdge
border edge
edge, double
the new border width
width)

Convenience method for setting the border width.

Inherited from org.apache.poi.sl.usermodel.TextShape:
appendTextgetInsetsgetTextgetTextDirectiongetTextHeightgetTextHeightgetTextParagraphsgetTextPlaceholdergetTextRotationgetVerticalAlignmentgetWordWrapisHorizontalCenteredresizeToFitTextresizeToFitTextsetHorizontalCenteredsetInsetssetTextsetTextDirectionsetTextPlaceholdersetTextRotationsetVerticalAlignmentsetWordWrap

Method Detail

getBorderStyleback to summary
public StrokeStyle getBorderStyle(TableCell.BorderEdge edge)

Return line style of given edge or null if border is not defined

Parameters
edge:TableCell.BorderEdge

the border edge

Returns:StrokeStyle

line style of given edge or null if border is not defined

getGridSpanback to summary
public int getGridSpan()

Get the number of columns to be spanned/merged

Returns:int

the grid span

Since
POI 3.15-beta2
getRowSpanback to summary
public int getRowSpan()

Get the number of rows to be spanned/merged

Returns:int

the row span

Since
POI 3.15-beta2
isMergedback to summary
public boolean isMerged()

Return if this cell is part of a merged cell. The top/left cell of a merged region is not regarded as merged - its grid and/or row span is greater than one.

Returns:boolean

true if this a merged cell

Since
POI 3.15-beta2
removeBorderback to summary
public void removeBorder(TableCell.BorderEdge edge)

Remove all line attributes of the given border edge

Parameters
edge:TableCell.BorderEdge

the border edge to be cleared

setBorderColorback to summary
public void setBorderColor(TableCell.BorderEdge edge, Color color)

Convenience method for setting the border color.

Parameters
edge:TableCell.BorderEdge

border edge

color:Color

the new border color

setBorderCompoundback to summary
public void setBorderCompound(TableCell.BorderEdge edge, StrokeStyle.LineCompound compound)

Convenience method for setting the border line compound.

Parameters
edge:TableCell.BorderEdge

border edge

compound:StrokeStyle.LineCompound

the new border line compound

setBorderDashback to summary
public void setBorderDash(TableCell.BorderEdge edge, StrokeStyle.LineDash dash)

Convenience method for setting the border line dash.

Parameters
edge:TableCell.BorderEdge

border edge

dash:StrokeStyle.LineDash

the new border line dash

setBorderStyleback to summary
public void setBorderStyle(TableCell.BorderEdge edge, StrokeStyle style)

Sets the StrokeStyle of the given border edge. A null property of the style is ignored.

Parameters
edge:TableCell.BorderEdge

border edge

style:StrokeStyle

the new stroke style

setBorderWidthback to summary
public void setBorderWidth(TableCell.BorderEdge edge, double width)

Convenience method for setting the border width.

Parameters
edge:TableCell.BorderEdge

border edge

width:double

the new border width

org.apache.poi.sl.usermodel back to summary

public final Enum TableCell.BorderEdge

extends Enum<TableCell.BorderEdge>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final TableCell.BorderEdge
bottom

public static final TableCell.BorderEdge
left

public static final TableCell.BorderEdge
right

public static final TableCell.BorderEdge
top

Constructor Summary

AccessConstructor and Description
private
BorderEdge()

Method Summary

Modifier and TypeMethod and Description
public static TableCell.BorderEdge
valueOf(String name)

public static TableCell.BorderEdge[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

bottomback to summary
public static final TableCell.BorderEdge bottom
leftback to summary
public static final TableCell.BorderEdge left
rightback to summary
public static final TableCell.BorderEdge right
topback to summary
public static final TableCell.BorderEdge top

Constructor Detail

BorderEdgeback to summary
private BorderEdge()

Method Detail

valueOfback to summary
public static TableCell.BorderEdge valueOf(String name)
valuesback to summary
public static TableCell.BorderEdge[] values()