Row (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.Row

All Implemented Interfaces:: java.lang.Iterable

public class Row
extends java.lang.Object
implements java.lang.Iterable

Represents a single row in a worksheet.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
 
         //Obtaining the reference of the first worksheet
         Worksheet worksheet = workbook.getWorksheets().get(0);
         Style style = workbook.createStyle();
 
         //Setting the background color to Blue
         style.setBackgroundColor(Color.getBlue());
 
         //Setting the foreground color to Red
         style.setForegroundColor(Color.getRed());
 
         //setting Background Pattern
         style.setPattern(BackgroundType.DIAGONAL_STRIPE);
 
         //New Style Flag
         StyleFlag styleFlag = new StyleFlag();
 
         //Set All Styles
         styleFlag.setAll(true);
 
          //Get first row
         Row row = worksheet.getCells().getRows().get(0);
          //Apply Style to first row
         row.applyStyle(style, styleFlag);
 
         //Saving the Excel file
         workbook.save("book1.xls");

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`applyStyle(Style style, StyleFlag flag)` Applies formats for a whole row.
`void`	`copySettings(Row source, boolean checkStyle)` Copy settings of row, such as style, height, visibility, ...etc.
`boolean`	`equals(java.lang.Object obj)` Checks whether this object refers to the same row with another.
`boolean`	`equals(Row row)` Checks whether this object refers to the same row with another row object.
`Cell`	`get(int column)` Gets the cell.
`Cell`	`getCellByIndex(int index)` Get the cell by specific index in the cells collection of this row.
`Cell`	`getCellOrNull(int column)` Gets the cell or null in the specific index.
`Cell`	`getFirstCell()` Gets the first cell object in the row.
`Cell`	`getFirstDataCell()` Gets the first non-blank cell in the row.
`byte`	`getGroupLevel()` Gets the group level of the row.
`double`	`getHeight()` Gets the row height in unit of Points.
`int`	`getIndex()` Gets the index of this row.
`Cell`	`getLastCell()` Gets the last cell object in the row.
`Cell`	`getLastDataCell()` Gets the last non-blank cell in the row.
`Style`	`getStyle()` Gets the style of this row.
`boolean`	`hasCustomStyle()` Indicates whether this row has custom style settings(different from the default one inherited from workbook).
`boolean`	`isBlank()` Indicates whether the row contains any data
`boolean`	`isCollapsed()` whether the row is collapsed
`boolean`	`isHeightMatched()` Indicates whether the row height matches current default font setting of the workbook.
`boolean`	`isHidden()` Indicates whether the row is hidden.
`java.util.Iterator`	`iterator()` Gets the cells enumerator
`java.util.Iterator`	`iterator(boolean reversed, boolean sync)` Gets an enumerator that iterates cells through this row.
`void`	`setCollapsed(boolean value)` whether the row is collapsed
`void`	`setGroupLevel(byte value)` Gets the group level of the row.
`void`	`setHeight(double value)` Sets the row height in unit of Points.
`void`	`setHeightMatched(boolean value)` Indicates whether the row height matches current default font setting of the workbook.
`void`	`setHidden(boolean value)` Indicates whether the row is hidden.
`void`	`setStyle(Style style)` Sets the style of this row.

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

- Method Detail
  - getCellByIndex
```
public Cell getCellByIndex(int index)
```
    Get the cell by specific index in the cells collection of this row.
    Remarks
    To traverse all cells in sequence without modification, using iterator() will give better performance than using this method to get cell one by one.
    
    Parameters:
    index - The index(position) of the cell in the cells collection of this row.
    
    Returns:
    The Cell object at given position.
  - isBlank
```
public boolean isBlank()
```
    Indicates whether the row contains any data
  - get
```
public Cell get(int column)
```
    Gets the cell.
    
    Parameters:
    column - The column index
    
    Returns:
  - iterator
```
public java.util.Iterator iterator()
```
    Gets the cells enumerator
    Example
```
 
         Workbook workbook = new Workbook("template.xlsx");
                Cells cells = workbook.getWorksheets().get(0).getCells();
 
                Iterator en = cells.getRows().get(1).iterator();
                while (en.hasNext())
                {
                    Cell cell = (Cell)en.next();
                    System.out.println(cell.getName() + ": " + cell.getValue());
                }
 
```
    Specified by:
    
    iterator in interface java.lang.Iterable
    
    Returns:
    The cells enumerator which will traverse all existing cells in this row.
  - iterator
```
public java.util.Iterator iterator(boolean reversed,
                          boolean sync)
```
    Gets an enumerator that iterates cells through this row.
    Remarks
    If the row will be modified(by operations that may cause new Cell be instantiated or existing Cell be removed) during the traversal with the enumerator, synchronized enumerator should be used instead of normal enumerator so that the traversal can continue from the position just after the one has been traversed by the last MoveNext(). However, together with the advantage that no element be skipped or traversed repeatedly, the disadvantage for synchronized enumerator is that the performance will be degraded a bit when comparing with normal enumerator.
    
    Parameters:
    reversed - whether enumerate cells in reversed order
    sync - whether the returned enumerator should check the modification of cells in this row and keep synchronized with it.
    
    Returns:
    The cells enumerator which will traverse all existing cells in this row.
  - getCellOrNull
```
public Cell getCellOrNull(int column)
```
    Gets the cell or null in the specific index.
    
    Parameters:
    column - The column index
    
    Returns:
    Returns the cell object if the cell exists. Or returns null if the cell object does not exist.
  - isCollapsed
```
public boolean isCollapsed()
```
    whether the row is collapsed
  - setCollapsed
```
public void setCollapsed(boolean value)
```
    whether the row is collapsed
  - getHeight
```
public double getHeight()
```
    Gets the row height in unit of Points.
  - setHeight
```
public void setHeight(double value)
```
    Sets the row height in unit of Points.
  - isHidden
```
public boolean isHidden()
```
    Indicates whether the row is hidden.
  - setHidden
```
public void setHidden(boolean value)
```
    Indicates whether the row is hidden.
  - getIndex
```
public int getIndex()
```
    Gets the index of this row.
  - getGroupLevel
```
public byte getGroupLevel()
```
    Gets the group level of the row.
  - setGroupLevel
```
public void setGroupLevel(byte value)
```
    Gets the group level of the row.
  - isHeightMatched
```
public boolean isHeightMatched()
```
    Indicates whether the row height matches current default font setting of the workbook. True of this property also denotes the row height is "automatic" without custom height value set by user.
    Remarks
    When this property is true, if the content in this row changes, generally the row height needs to be re-calculated(such as by Worksheet.autoFitRows()) to get the same result with what is shown in ms excel when you opening the workbook in it.
  - setHeightMatched
```
public void setHeightMatched(boolean value)
```
    Indicates whether the row height matches current default font setting of the workbook. True of this property also denotes the row height is "automatic" without custom height value set by user.
    Remarks
    When this property is true, if the content in this row changes, generally the row height needs to be re-calculated(such as by Worksheet.autoFitRows()) to get the same result with what is shown in ms excel when you opening the workbook in it.
  - getStyle
```
public Style getStyle()
```
    Gets the style of this row.
    Remarks
    Modifying the returned style object directly takes no effect for this row or any cells in this row. You have to call Column.applyStyle(Style,StyleFlag) or Column.setStyle(Style) method to apply the change to this row.
    
    Row's style is the style which will be inherited by cells in this row(those cells that have no custom style settings, such as existing cells that have not been set style explicitly, or those that have not been instantiated)
  - setStyle
```
public void setStyle(Style style)
```
    Sets the style of this row.
    Remarks
    This method only sets the given style as the default style for this row, without changing the style settings for existing cells in this row. To update style settings of existing cells to the specified style at the same time, please use Column.applyStyle(Style,StyleFlag)
    
    Parameters:
    style - the style to be used as the default style for cells in this row.
  - hasCustomStyle
```
public boolean hasCustomStyle()
```
    Indicates whether this row has custom style settings(different from the default one inherited from workbook).
  - copySettings
```
public void copySettings(Row source,
                boolean checkStyle)
```
    Copy settings of row, such as style, height, visibility, ...etc.
    
    Parameters:
    source - the source row whose settings will be copied to this one
    checkStyle - whether check and gather style. Only takes effect and be needed when two row objects belong to different workbook and the styles of two workbooks are different.
  - getFirstCell
```
public Cell getFirstCell()
```
    Gets the first cell object in the row.
  - getFirstDataCell
```
public Cell getFirstDataCell()
```
    Gets the first non-blank cell in the row.
  - getLastCell
```
public Cell getLastCell()
```
    Gets the last cell object in the row.
  - getLastDataCell
```
public Cell getLastDataCell()
```
    Gets the last non-blank cell in the row.
  - applyStyle
```
public void applyStyle(Style style,
              StyleFlag flag)
```
    Applies formats for a whole row.
    
    Parameters:
    style - The style object which will be applied.
    flag - Flags which indicates applied formatting properties.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks whether this object refers to the same row with another.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - another object
    
    Returns:
    true if two objects refers to the same row.
  - equals
```
public boolean equals(Row row)
```
    Checks whether this object refers to the same row with another row object.
    
    Parameters:
    row - another row object
    
    Returns:
    true if two row objects refers to the same row.

Class Row

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCellByIndex

isBlank

get

iterator

iterator

getCellOrNull

isCollapsed

setCollapsed

getHeight

setHeight

isHidden

setHidden

getIndex

getGroupLevel

setGroupLevel

isHeightMatched

setHeightMatched

getStyle

setStyle

hasCustomStyle

copySettings

getFirstCell

getFirstDataCell

getLastCell

getLastDataCell

applyStyle

equals

equals