Style Intelligence v12.0

inetsoft.report
Class FreehandLayout

java.lang.Object
  extended by inetsoft.report.BaseLayout
      extended by inetsoft.report.FreehandLayout
All Implemented Interfaces:
inetsoft.util.XMLSerializable, Serializable, Cloneable

public class FreehandLayout
extends BaseLayout

Define a freehand table layout where multiple rows in a table can be mapped to a single row in the raw data. Per-cell binding can be defined to display the data in any cell of the table instead of in strictly tabular rows. It also stored cell span information.

See Also:
Serialized Form

Nested Class Summary
static class FreehandLayout.CellBinding
          Defines the per cell binding.
 
Nested classes/interfaces inherited from class inetsoft.report.BaseLayout
BaseLayout.Region
 
Field Summary
static int BIND_COLUMN
          Cell binding: Bind to a column in the data table lens.
static int BIND_FORMULA
          Cell binding: Bind to a formula.
static int BIND_TEXT
          Cell binding: Static text in a cell.
static int LAYOUT_ALL
          Layout type for complete freehand cell layout.
static int LAYOUT_HEADER
          Layout type for header only layout.
static int LAYOUT_IDENTICAL
          Layout type for identical layout.
 
Fields inherited from class inetsoft.report.BaseLayout
ncol, regions, spans
 
Constructor Summary
FreehandLayout()
          Create an empty layout.
FreehandLayout(TableLens table)
          Create a layout that matches the table lens.
 
Method Summary
 void clear()
          Clear all settings in the layout.
 TableDataPath fixPathForRegion(TableDataPath path)
          Fix the table data path for region data path.
 BaseLayout.Region getRegion(TableDataPath path)
          Get the region defined for the data path.
 int getType()
          Get the layout type.
 void parseXML(Element tag)
          Parse xml data into object.
 void setType(int type)
          Set the layout type.
 void updateRegions(TableLens table)
          Create all regions that are currently not in the layout.
 void writeXML(PrintWriter writer)
          Write layout to xml format.
 
Methods inherited from class inetsoft.report.BaseLayout
addRegion, addRegion, clone, convertToGlobalRow, convertToRegionRow, convertToRegionRow, createCellBinding, debug, equals, equals, equalsContent, findSpan, getCellBinding, getColCount, getMergedGroup, getRegion, getRegionCount, getRegionDataPaths, getRegionPath, getRegions, getRowCount, getRowCount, getRowHeight, getSpan, getVisibleRowCount, hasCrossRegionSpan, insertColumn, insertRow, insertRow, locateRegion, locateRegion, locateRegionIndex, locateRow, parseRegions, parseSpan, removeColumn, removeEmptyRegions, removeRegion, removeRegion, removeRow, removeRow, setCellBinding, setColCount, setMergedGroup, setRowHeight, setSpan, toString, writeRegions, writeSpan
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BIND_TEXT

public static final int BIND_TEXT
Cell binding: Static text in a cell.

See Also:
Constant Field Values

BIND_COLUMN

public static final int BIND_COLUMN
Cell binding: Bind to a column in the data table lens.

See Also:
Constant Field Values

BIND_FORMULA

public static final int BIND_FORMULA
Cell binding: Bind to a formula.

See Also:
Constant Field Values

LAYOUT_IDENTICAL

public static final int LAYOUT_IDENTICAL
Layout type for identical layout. The layout matches the original table and can be ignored at runtime.

See Also:
Constant Field Values

LAYOUT_HEADER

public static final int LAYOUT_HEADER
Layout type for header only layout. The non-header rows are not changed by the layout.

See Also:
Constant Field Values

LAYOUT_ALL

public static final int LAYOUT_ALL
Layout type for complete freehand cell layout.

See Also:
Constant Field Values
Constructor Detail

FreehandLayout

public FreehandLayout()
Create an empty layout.


FreehandLayout

public FreehandLayout(TableLens table)
Create a layout that matches the table lens. If this layout is applied as is, it is a no-op.

Method Detail

updateRegions

public void updateRegions(TableLens table)
Create all regions that are currently not in the layout.


getType

public int getType()
Get the layout type.


setType

public void setType(int type)
Set the layout type. The layout type should reflect what is contained in the layout. It's used to optimize the processing. Different logic may be invoked according to the layout type.

Parameters:
type - one of the defined layout types.

clear

public void clear()
Clear all settings in the layout.

Overrides:
clear in class BaseLayout

getRegion

public BaseLayout.Region getRegion(TableDataPath path)
Get the region defined for the data path.

Overrides:
getRegion in class BaseLayout
Parameters:
path - row data path.

writeXML

public void writeXML(PrintWriter writer)
Write layout to xml format.


parseXML

public void parseXML(Element tag)
              throws Exception
Parse xml data into object.

Throws:
Exception

fixPathForRegion

public TableDataPath fixPathForRegion(TableDataPath path)
Fix the table data path for region data path.

Specified by:
fixPathForRegion in class BaseLayout

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.