RowHandle (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.OpenXLS.RowHandle

```
public class RowHandle
extends Object
```
The RowHandle provides access to a Worksheet Row and its Cells.
Use the RowHandle to work with individual Rows in an XLS file.
With a RowHandle you can:
get a handle to the Cells in a row
set the default formatting for a Row

See Also:

WorkBookHandle, WorkSheetHandle, FormulaHandle

Field Summary

Fields
Modifier and Type Field and Description

Row myRow

static int ROW_HEIGHT_DIVISOR

Fields
Modifier and Type	Field and Description
`Row`	`myRow`
`static int`	`ROW_HEIGHT_DIVISOR`

Constructor Summary

Constructors
Modifier Constructor and Description

protected RowHandle(Row c, WorkSheetHandle ws)

Constructors
Modifier	Constructor and Description
`protected`	`RowHandle(Row c, WorkSheetHandle ws)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsVerticalMergeRange()` Determines if the row passes through a vertical merge range
`CellHandle[]`	`getCells()` Returns the array of Cells in this Row
`CellHandle[]`	`getCells(boolean cached)` Returns the array of Cells in this Row
`int[]`	`getColDimensions()` return the min/max columns defined for this row
`FormatHandle`	`getFormatHandle()` Gets the FormatHandle for this Row.
`int`	`getFormatId()` gets the current default row format id.
`boolean`	`getHasAnyBottomBorder()` Additional space below the row.
`boolean`	`getHasAnyThickTopBorder()` returns true if there is a thick top or thick or medium bottom border on previoous row Not useful for public API
`boolean`	`getHasThickBottomBorder()` returns true if there is a Thick Bottom border set on the row
`boolean`	`getHasThickTopBorder()` returns true if there is a Thick Top border set on the row
`int`	`getHeight()` Return the row height of an existing row.
`static int`	`getHeight(Boundsheet sheet, int row)` Return the row height of an existing row.
`int`	`getHeightInChars()` returns the row height in Excel units, which depends upon the default font in Arial 10 pt, standard row height is 12.75 points
`String`	`getJSON()` Get the JSON object for this row.
`org.json.JSONObject`	`getJSON(int maxcols)`
`int`	`getOutlineLevel()` Returns the Outline level (depth) of the row
`int`	`getRowNumber()` Returns the row number of this RowHandle
`WorkBook`	`getWorkBook()`
`WorkSheetHandle`	`getWorkSheetHandle()`
`boolean`	`isAlteredHeight()` true if row height has been altered from default i.e.
`boolean`	`isCollapsed()` Returns whether the row is collapsed
`boolean`	`isHidden()` Returns whether the row is hidden
`void`	`setBackgroundColor(Color colr)`
`void`	`setCollapsed(boolean b)` Set whether the row is collapsed.
`void`	`setFormatId(int i)` sets the default format id for the Row's Cells
`void`	`setHasThickBottomBorder(boolean hasBorder)` sets this row to have a thick bottom border
`void`	`setHasThickTopBorder(boolean hasBorder)` sets this row to have a thick top border
`void`	`setHeight(int newHeight)` Sets the row height in twips (1/20th of a point)
`void`	`setHeightInChars(int newHeight)` sets the row height in Excel units.
`void`	`setHidden(boolean b)` Set whether the row is hidden
`void`	`setOutlineLevel(int x)` Set the Outline level (depth) of the row
`void`	`setRowHeightAutoFit()` sets the row height to auto fit When the row height is set manually, autofit is automatically turned off
`String`	`toString()` Returns the String representation of this Row

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

- Field Detail
  - ROW_HEIGHT_DIVISOR
```
public static int ROW_HEIGHT_DIVISOR
```
  - myRow
```
public Row myRow
```
- Constructor Detail
  - RowHandle
```
protected RowHandle(Row c,
                    WorkSheetHandle ws)
```
- Method Detail
  - getHeight
```
public int getHeight()
```
    Return the row height of an existing row. These values are returned in twips, 1/20th of a character.
    
    Returns:
    
    int Height of Row in twips
  - getHeightInChars
```
public int getHeightInChars()
```
    returns the row height in Excel units, which depends upon the default font
    in Arial 10 pt, standard row height is 12.75 points
    
    Returns:
    
    int row height in Excel units
  - getHeight
```
public static int getHeight(Boundsheet sheet,
                            int row)
```
    Return the row height of an existing row. These values are returned in twips, 1/20th of a character.
    
    Parameters:
    
    sheet -
    
    row -
    
    Returns:
  - setHeightInChars
```
public void setHeightInChars(int newHeight)
```
    sets the row height in Excel units.
    
    Parameters:
    
    double - i - row height value in Excel units
  - setRowHeightAutoFit
```
public void setRowHeightAutoFit()
```
    sets the row height to auto fit
    When the row height is set manually, autofit is automatically turned off
  - setHeight
```
public void setHeight(int newHeight)
```
    Sets the row height in twips (1/20th of a point)
    
    Parameters:
    
    newHeight -
  - containsVerticalMergeRange
```
public boolean containsVerticalMergeRange()
```
    Determines if the row passes through a vertical merge range
    
    Returns:
  - setFormatId
```
public void setFormatId(int i)
```
    sets the default format id for the Row's Cells
    
    Parameters:
    
    int - Format Id for all Cells in Row
  - getFormatHandle
```
public FormatHandle getFormatHandle()
```
    Gets the FormatHandle for this Row.
    
    Returns:
    
    FormatHandle - a Format object to apply to this Row
  - getFormatId
```
public int getFormatId()
```
    gets the current default row format id. May be overwritten by contained cells
    
    Returns:
    
    format id of row
  - getCells
```
public CellHandle[] getCells(boolean cached)
```
    Returns the array of Cells in this Row
    
    Parameters:
    
    cache - cellhandles flag
    
    Returns:
    
    Cell[] all Cells in this Row
  - getCells
```
public CellHandle[] getCells()
```
    Returns the array of Cells in this Row
    
    Returns:
    
    Cell[] all Cells in this Row
  - getJSON
```
public String getJSON()
```
    Get the JSON object for this row.
    
    Returns:
  - getJSON
```
public org.json.JSONObject getJSON(int maxcols)
```
  - toString
```
public String toString()
```
    Returns the String representation of this Row
    
    Overrides:
    
    toString in class Object
  - getRowNumber
```
public int getRowNumber()
```
    Returns the row number of this RowHandle
  - setCollapsed
```
public void setCollapsed(boolean b)
```
    Set whether the row is collapsed. Will hide the current row, and all contiguous rows with the same outline level.
    
    Parameters:
    
    b -
  - setHidden
```
public void setHidden(boolean b)
```
    Set whether the row is hidden
    
    Parameters:
    
    b -
  - setOutlineLevel
```
public void setOutlineLevel(int x)
```
    Set the Outline level (depth) of the row
    
    Parameters:
    
    x -
  - getOutlineLevel
```
public int getOutlineLevel()
```
    Returns the Outline level (depth) of the row
    
    Returns:
  - isCollapsed
```
public boolean isCollapsed()
```
    Returns whether the row is collapsed
    
    Returns:
  - isHidden
```
public boolean isHidden()
```
    Returns whether the row is hidden
    
    Returns:
  - isAlteredHeight
```
public boolean isAlteredHeight()
```
    true if row height has been altered from default i.e. set manually
    
    Returns:
  - setBackgroundColor
```
public void setBackgroundColor(Color colr)
```
  - getHasThickTopBorder
```
public boolean getHasThickTopBorder()
```
    returns true if there is a Thick Top border set on the row
  - getHasThickBottomBorder
```
public boolean getHasThickBottomBorder()
```
    returns true if there is a Thick Bottom border set on the row
  - getHasAnyThickTopBorder
```
public boolean getHasAnyThickTopBorder()
```
    returns true if there is a thick top or thick or medium bottom border on previoous row Not useful for public API
  - getHasAnyBottomBorder
```
public boolean getHasAnyBottomBorder()
```
    Additional space below the row. This flag is set, if the lower border of at least one cell in this row or if the upper border of at least one cell in the row below is formatted with a medium or thick line style. Thin line styles are not taken into account. Usage of this method is primarily for UI applications, and is not needed for standard OpenXLS functionality
  - setHasThickTopBorder
```
public void setHasThickTopBorder(boolean hasBorder)
```
    sets this row to have a thick top border
  - setHasThickBottomBorder
```
public void setHasThickBottomBorder(boolean hasBorder)
```
    sets this row to have a thick bottom border
  - getColDimensions
```
public int[] getColDimensions()
```
    return the min/max columns defined for this row
    
    Returns:
  - getWorkBook
```
public WorkBook getWorkBook()
```
  - getWorkSheetHandle
```
public WorkSheetHandle getWorkSheetHandle()
```

Class RowHandle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROW_HEIGHT_DIVISOR

myRow

Constructor Detail

RowHandle

Method Detail

getHeight

getHeightInChars

getHeight

setHeightInChars

setRowHeightAutoFit

setHeight

containsVerticalMergeRange

setFormatId

getFormatHandle

getFormatId

getCells

getCells

getJSON

getJSON

toString

getRowNumber

setCollapsed

setHidden

setOutlineLevel

getOutlineLevel

isCollapsed

isHidden

isAlteredHeight

setBackgroundColor

getHasThickTopBorder

getHasThickBottomBorder

getHasAnyThickTopBorder

getHasAnyBottomBorder

setHasThickTopBorder

setHasThickBottomBorder

getColDimensions

getWorkBook

getWorkSheetHandle