Package ch.rabanti.nanoxlsx4j

Class Shortener

java.lang.Object
ch.rabanti.nanoxlsx4j.Shortener
public class Shortener extends Object
Class to provide access to the current worksheet with a shortened syntax
Note: The WS object can be null if the workbook was created without a worksheet. The object will be available as soon as the current worksheet is defined
Author:
Raphael Stoeckli

  • Constructor Summary

    Constructors
    Constructor
    Description
    Shortener(Workbook reference)
    Constructor with workbook reference

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    down()
    Moves the cursor one row down
    void
    down(int numberOfRows)
    Moves the cursor the number of defined rows down
    void
    down(int numberOfRows, boolean keepColumnPosition)
    Moves the cursor the number of defined rows down
    void
    formula(String formula)
    Sets a formula into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
    void
    formula(String formula, Style style)
    Sets a formula with style into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
    void
    left()
    Moves the cursor one column to the left
    void
    left(int numberOfColumns)
    Moves the cursor the number of defined columns to the left
    void
    left(int numberOfColumns, boolean keepRowPosition)
    Moves the cursor the number of defined columns to the left
    void
    right()
    Moves the cursor one column to the right
    void
    right(int numberOfColumns)
    Moves the cursor the number of defined columns to the right
    void
    right(int numberOfColumns, boolean keepRowPosition)
    Moves the cursor the number of defined columns to the right
    void
    setCurrentWorksheet(Worksheet worksheet)
    Sets the worksheet accessed by the shortener
    void
    up()
    Moves the cursor one row up
    void
    up(int numberOfRows)
    Moves the cursor the number of defined rows up
    void
    up(int numberOfRows, boolean keepColumnPosition)
    Moves the cursor the number of defined rows up
    void
    value(Object value)
    Sets a value into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
    void
    value(Object value, Style style)
    Sets a value with style into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Shortener

      public Shortener(Workbook reference)
      Constructor with workbook reference
      Parameters:
      reference - Workbook reference

  • Method Details

    • setCurrentWorksheet

      public void setCurrentWorksheet(Worksheet worksheet)
      Sets the worksheet accessed by the shortener
      Parameters:
      worksheet - Current worksheet

    • value

      public void value(Object value)
      Sets a value into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
      Parameters:
      value - Value to set
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • value

      public void value(Object value, Style style)
      Sets a value with style into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
      Parameters:
      value - Value to set
      style - Style to set
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • formula

      public void formula(String formula)
      Sets a formula into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
      Parameters:
      formula - Formula to set
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • formula

      public void formula(String formula, Style style)
      Sets a formula with style into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
      Parameters:
      formula - Formula to set
      style - Style to set
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • down

      public void down()
      Moves the cursor one row down
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • down

      public void down(int numberOfRows)
      Moves the cursor the number of defined rows down
      Parameters:
      numberOfRows - Number of rows to move
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • down

      public void down(int numberOfRows, boolean keepColumnPosition)
      Moves the cursor the number of defined rows down
      Parameters:
      numberOfRows - Number of rows to move
      keepColumnPosition - If true, the column position is preserved, otherwise set to 0
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • up

      public void up()
      Moves the cursor one row up
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined
      RangeException - Throws a RangeException if the row number is below 0

    • up

      public void up(int numberOfRows)
      Moves the cursor the number of defined rows up
      API Note:
      Values can be also negative. However, this is the equivalent of the function down(int)}
      Parameters:
      numberOfRows - Number of rows to move
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined
      RangeException - Throws a RangeException if the row number is below 0

    • up

      public void up(int numberOfRows, boolean keepColumnPosition)
      Moves the cursor the number of defined rows up
      API Note:
      Values can be also negative. However, this is the equivalent of the function down(int)}
      Parameters:
      numberOfRows - Number of rows to move
      keepColumnPosition - If true, the column position is preserved, otherwise set to 0
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined
      RangeException - Throws a RangeException if the row number is below 0

    • right

      public void right()
      Moves the cursor one column to the right
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • right

      public void right(int numberOfColumns)
      Moves the cursor the number of defined columns to the right
      Parameters:
      numberOfColumns - Number of columns to move
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • right

      public void right(int numberOfColumns, boolean keepRowPosition)
      Moves the cursor the number of defined columns to the right
      Parameters:
      numberOfColumns - Number of columns to move
      keepRowPosition - If true, the row position is preserved, otherwise set to 0
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined

    • left

      public void left()
      Moves the cursor one column to the left
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined
      RangeException - Throws a RangeException if the column number is below 0

    • left

      public void left(int numberOfColumns)
      Moves the cursor the number of defined columns to the left
      API Note:
      Values can be also negative. However, this is the equivalent of the function right(int)}
      Parameters:
      numberOfColumns - Number of columns to move
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined
      RangeException - Throws a RangeException if the column number is below 0

    • left

      public void left(int numberOfColumns, boolean keepRowPosition)
      Moves the cursor the number of defined columns to the left
      API Note:
      Values can be also negative. However, this is the equivalent of the function right(int)}
      Parameters:
      numberOfColumns - Number of columns to move
      keepRowPosition - If true, the row position is preserved, otherwise set to 0
      Throws:
      WorksheetException - Throws a WorksheetException if no worksheet was defined
      RangeException - Throws a RangeException if the column number is below 0