Method Details

• getTitleRowStart

  public final int getTitleRowStart()

  Gets the start index of the rows that are the title of the range.

  Use this method to retrieve the first row in the title row range configured by setTitleRowStart(int) and setTitleRowEnd(int).

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTitleRowStart(1);
   repeatSetting.setTitleRowEnd(3);
   int titleRowStart = repeatSetting.getTitleRowStart();
   

  Returns:

  The start index of the rows that are the title of the range.

• setTitleRowStart

  public final void setTitleRowStart(int value)

  Sets the start index of the rows that are the title of the range.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTitleRowStart(1);
   repeatSetting.setTitleRowEnd(3);
   

  Parameters:

  value - The start index of the rows that are the title of the range.

• getTitleRowEnd

  public final int getTitleRowEnd()

  Gets the end index of the rows that are printed at the top of the page.

  Use this method to retrieve the last row index in the title-row range configured by setTitleRowStart(int) and setTitleRowEnd(int).

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTitleRowStart(1);
   repeatSetting.setTitleRowEnd(3);
   int titleRowEnd = repeatSetting.getTitleRowEnd();
   

  Returns:

  The end index of the rows that are printed at the top of the page. Returns -1 if the title row end index has not been set.

• setTitleRowEnd

  public final void setTitleRowEnd(int value)

  Sets the end index of the rows that are printed at the top of the page.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTitleRowStart(1);
   repeatSetting.setTitleRowEnd(3);
   

  Parameters:

  value - The end index of the rows that are printed at the top of the page. Sets -1 if the title row end index has not been set.

• getTailRowStart

  public final int getTailRowStart()

  Returns the start index of the rows that are the tail of the range.

  This value identifies the first tail row in the RepeatSetting. Tail rows are the rows at the end of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTailRowStart(2);
   repeatSetting.setTailRowEnd(4);
   int tailRowStart = repeatSetting.getTailRowStart();
   

  Returns:

  The start index of the rows that are the tail of the range.

• setTailRowStart

  public final void setTailRowStart(int value)

  Sets the start index of the rows that belong to the tail area of the range.

  This value identifies the first tail row in the RepeatSetting. Tail rows are the rows at the end of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTailRowStart(2);
   repeatSetting.setTailRowEnd(4);
   

  Parameters:

  value - The start index of the tail rows in the range.

• getTailRowEnd

  public final int getTailRowEnd()

  Gets the end index of the rows that belong to the tail area of the range.

  This value identifies the last tail row in the RepeatSetting. Tail rows are the rows at the end of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTailRowStart(2);
   repeatSetting.setTailRowEnd(4);
   int tailRowEnd = repeatSetting.getTailRowEnd();
   

  Returns:

  The end index of the tail rows in the range. Returns -1 if the tail row end index has not been set.

• setTailRowEnd

  public final void setTailRowEnd(int value)

  Sets the end index of the rows that belong to the tail area of the range.

  This value identifies the last tail row in the RepeatSetting. Tail rows are the rows at the end of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTailRowStart(2);
   repeatSetting.setTailRowEnd(4);
   

  Parameters:

  value - The end index of the tail rows in the range. Sets -1 if the tail row end index has not been set.

• getTitleColumnStart

  public final int getTitleColumnStart()

  Gets the start index of the columns that belong to the title area of the range.

  This value identifies the first title column in the RepeatSetting. Title columns are the columns at the left side of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTitleColumnStart(1);
   repeatSetting.setTitleColumnEnd(3);
   int titleColumnStart = repeatSetting.getTitleColumnStart();
   

  Returns:

  The start index of the title columns in the range. Returns -1 if the title column start index has not been set.

• setTitleColumnStart

  public final void setTitleColumnStart(int value)

  Sets the start index of the columns that belong to the title area of the range.

  This value identifies the first title column in the RepeatSetting. Title columns are the columns at the left side of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTitleColumnStart(1);
   repeatSetting.setTitleColumnEnd(3);
   

  Parameters:

  value - The start index of the title columns in the range. Sets -1 if the title column start index has not been set.

• getTitleColumnEnd

  public final int getTitleColumnEnd()

  Gets the end index of the columns that are printed at the left of the page.

  Use this method to retrieve the last column index in the title-column range configured by setTitleColumnStart(int) and setTitleColumnEnd(int).

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTitleColumnStart(1);
   repeatSetting.setTitleColumnEnd(3);
   int titleColumnEnd = repeatSetting.getTitleColumnEnd();
   

  Returns:

  The end index of the columns that are printed at the left of the page.

• setTitleColumnEnd

  public final void setTitleColumnEnd(int value)

  Sets the end index of the columns that are printed at the left of the page.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTitleColumnStart(1);
   repeatSetting.setTitleColumnEnd(3);
   

  Parameters:

  value - The end index of the columns that are printed at the left of the page.

• getTailColumnStart

  public final int getTailColumnStart()

  Gets the start index of the columns that belong to the tail area of the range.

  This value identifies the first tail column in the RepeatSetting. Tail columns are the columns at the end of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTailColumnStart(2);
   repeatSetting.setTailColumnEnd(4);
   int tailColumnStart = repeatSetting.getTailColumnStart();
   

  Returns:

  The start index of the tail columns in the range. Returns -1 if the tail column start index has not been set.

• setTailColumnStart

  public final void setTailColumnStart(int value)

  Sets the start index of the columns that belong to the tail area of the range.

  This value identifies the first tail column in the RepeatSetting. Tail columns are the columns at the end of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTailColumnStart(2);
   repeatSetting.setTailColumnEnd(4);
   

  Parameters:

  value - The start index of the tail columns in the range. Sets -1 if the tail column start index has not been set.

• getTailColumnEnd

  public final int getTailColumnEnd()

  Gets the end index of the columns that belong to the tail area of the range.

  This value identifies the last tail column in the RepeatSetting. Tail columns are the columns at the end of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTailColumnStart(2);
   repeatSetting.setTailColumnEnd(4);
   int tailColumnEnd = repeatSetting.getTailColumnEnd();
   

  Returns:

  The end index of the tail columns in the range. Returns -1 if the tail column end index has not been set.

• setTailColumnEnd

  public final void setTailColumnEnd(int value)

  Sets the end index of the columns that belong to the tail area of the range.

  This value identifies the last tail column in the RepeatSetting. Tail columns are the columns at the end of the associated range that can be repeated during pagination.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setTailColumnStart(2);
   repeatSetting.setTailColumnEnd(4);
   

  Parameters:

  value - The end index of the tail columns in the range. Sets -1 if the tail column end index has not been set.

• getRange

  public final IRange getRange()

  Returns an instance of IRange whose repeat settings are the same.

  
   IRange range = worksheet.getRange("A1:D20");
   RepeatSetting repeatSetting = new RepeatSetting();
   repeatSetting.setRange(range);
   repeatSetting.setTitleRowStart(0);
   repeatSetting.setTitleRowEnd(1);
   IRange repeatedRange = repeatSetting.getRange();
   

  Returns:

  An instance of IRange whose repeat settings are the same.

• setRange

  public final void setRange(IRange value)

  Sets the IRange instance whose repeat settings are represented by this RepeatSetting.

  Use this method to associate the repeat setting with a specific worksheet range.

  
   RepeatSetting repeatSetting = new RepeatSetting();
   IRange range = worksheet.getRange("A1:C5");
   repeatSetting.setRange(range);
   

  Parameters:

  value - The range whose repeat settings are the same as this RepeatSetting; may be null.