com.groupdocs.parser.templates

Class TemplateTable

java.lang.Object

com.groupdocs.parser.templates.TemplateItem

com.groupdocs.parser.templates.TemplateTable

public class TemplateTable
extends TemplateItem

Provides the template table.

There are two ways to define a table:

• Using TemplateTableLayout class. In this case the table is defined by its position on the page: rectangular area, columns and rows separators.
• Using TemplateTableParameters class. In this case the table is detected automatically by algorithms with set parameters. See TemplateTableParameters class for more information.

Constructor Summary

Constructors

Constructor and Description
TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex) Initializes a new instance of the TemplateTable class with the UPPER CASE name.
TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, boolean useUpperCaseName) Initializes a new instance of the TemplateTable class.
TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, Double pageWidth) Initializes a new instance of the TemplateTable class with the UPPER CASE name.
TemplateTable(TemplateTableLayout layout, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName) Initializes a new instance of the TemplateTable class.
TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex) Initializes a new instance of the TemplateTable class with the UPPER CASE name.
TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, boolean useUpperCaseName) Initializes a new instance of the TemplateTable class.
TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, Double pageWidth) Initializes a new instance of the TemplateTable class.
TemplateTable(TemplateTableParameters parameters, String name, Integer pageIndex, Double pageWidth, boolean useUpperCaseName) Initializes a new instance of the TemplateTable class.

Method Summary

Modifier and Type	Method and Description
TemplateTableLayout	getLayout() Gets the table layout.
TemplateTableParameters	getParameters() Gets the parameters to detect the table in the automatic mode.
TemplateItem	scale(double factor) Creates a copy of the current item with all coordinates scaled by the given factor.

Methods inherited from class com.groupdocs.parser.templates.TemplateItem

getName, getPageIndex, getPageWidth, getUseUpperCaseName

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateTable

public TemplateTable(TemplateTableLayout layout,
                     String name,
                     Integer pageIndex)

Initializes a new instance of the TemplateTable class with the UPPER CASE name.

Template table is set by table layout if the table can't be detected automatically:

 TemplateTableLayout layout = new TemplateTableLayout(
     java.util.Arrays.asList(new Double[] { 50.0, 95.0, 275.0 }),
     java.util.Arrays.asList(new Double[] { 325.0, 340.0, 365.0 }));
 TemplateTable table = new TemplateTable(layout, "Details", null);
 // Create a document template
 Template template = new Template(java.util.Arrays.asList(new TemplateItem[] { table }));

Parameters:

layout - The table layout.

name - The table name.

pageIndex - The index of the page where the template table is located; null if the template table is located on any page.

TemplateTable

public TemplateTable(TemplateTableLayout layout,
                     String name,
                     Integer pageIndex,
                     Double pageWidth)

Initializes a new instance of the TemplateTable class with the UPPER CASE name.

Parameters:

layout - The table layout.

name - The table name.

pageIndex - The index of the page where the template table is located; null if the template table is located on any page.

pageWidth - The width of the page that was used to create the template item.

TemplateTable

public TemplateTable(TemplateTableLayout layout,
                     String name,
                     Integer pageIndex,
                     boolean useUpperCaseName)

Initializes a new instance of the TemplateTable class.

Parameters:

layout - The table layout.

name - The table name.

pageIndex - The index of the page where the template table is located; null if the template table is located on any page.

useUpperCaseName - The value that indicates whether a name is converted to UPPER CASE.

TemplateTable

public TemplateTable(TemplateTableLayout layout,
                     String name,
                     Integer pageIndex,
                     Double pageWidth,
                     boolean useUpperCaseName)

Initializes a new instance of the TemplateTable class.

Parameters:

layout - The table layout.

name - The table name.

pageIndex - The index of the page where the template table is located; null if the template table is located on any page.

pageWidth - The width of the page that was used to create the template item.

useUpperCaseName - The value that indicates whether a name is converted to UPPER CASE.

TemplateTable

public TemplateTable(TemplateTableParameters parameters,
                     String name,
                     Integer pageIndex)

Initializes a new instance of the TemplateTable class with the UPPER CASE name.

If a template table is set by detector parameters, the table is detected automatically:

 TemplateTableParameters parameters = new TemplateTableParameters(
     new Rectangle(new Point(175, 350), new Size(400, 200)),
     java.util.Arrays.asList(new Double[] { 185.0, 370.0, 425.0, 485.0, 545.0 }));
 TemplateTable table = new TemplateTable(parameters, "Details", 0);
 // Create a document template
 Template template = new Template(java.util.Arrays.asList(new TemplateItem[] { table }));
 

Parameters:

parameters - The parameters to detect the table in the automatic mode.

name - The table name.

pageIndex - The index of the page where the template table is located; null if the template table is located on any page.

TemplateTable

public TemplateTable(TemplateTableParameters parameters,
                     String name,
                     Integer pageIndex,
                     Double pageWidth)

Initializes a new instance of the TemplateTable class.

Parameters:

parameters - The parameters to detect the table in the automatic mode.

name - The table name.

pageIndex - The index of the page where the template table is located; null if the template table is located on any page.

pageWidth - The width of the page that was used to create the template item.

TemplateTable

public TemplateTable(TemplateTableParameters parameters,
                     String name,
                     Integer pageIndex,
                     boolean useUpperCaseName)

Initializes a new instance of the TemplateTable class.

Parameters:

parameters - The parameters to detect the table in the automatic mode.

name - The table name.

pageIndex - The index of the page where the template table is located; null if the template table is located on any page.

useUpperCaseName - The value that indicates whether a name is converted to UPPER CASE.

TemplateTable

public TemplateTable(TemplateTableParameters parameters,
                     String name,
                     Integer pageIndex,
                     Double pageWidth,
                     boolean useUpperCaseName)

Initializes a new instance of the TemplateTable class.

Parameters:

parameters - The parameters to detect the table in the automatic mode.

name - The table name.

pageIndex - The index of the page where the template table is located; null if the template table is located on any page.

pageWidth - The width of the page that was used to create the template item.

useUpperCaseName - The value that indicates whether a name is converted to UPPER CASE.

Method Detail

getLayout

public TemplateTableLayout getLayout()

Gets the table layout.

Returns:

An instance of TemplateTableLayout class that represents the table layout; null if it isn't set.

getParameters

public TemplateTableParameters getParameters()

Gets the parameters to detect the table in the automatic mode.

Returns:

An instance of TemplateTableParameters class that represents the parameters to detect the table in the automatic mode; null if it isn't set.

scale

public TemplateItem scale(double factor)

Description copied from class: TemplateItem

Creates a copy of the current item with all coordinates scaled by the given factor.

Specified by:

scale in class TemplateItem

Parameters:

factor - The scaling factor.

Returns:

A new TemplateItem with scaled coordinates.