org.eclipse.birt.report.model.api
Class GridHandle

java.lang.Object
  extended byorg.eclipse.birt.report.model.api.DesignElementHandle
      extended byorg.eclipse.birt.report.model.api.ReportElementHandle
          extended byorg.eclipse.birt.report.model.api.ReportItemHandle
              extended byorg.eclipse.birt.report.model.api.GridHandle
All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IGridItemModel, org.eclipse.birt.report.model.elements.interfaces.IReportItemModel, org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel

public class GridHandle
extends ReportItemHandle
implements org.eclipse.birt.report.model.elements.interfaces.IGridItemModel

Represents a grid item in the design. A grid item contains a set of report items arranged into a grid. Grids contains rows and columns. The grid contains cells. Each cell can span one or more columns, or one or more rows. Each cell can contain one or more items.

Grid layout is familiar to anyone who has used HTML tables, Word tables or Excel: data is divided into a series of rows and columns.

See Also:
GridItem

Field Summary
 
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
element
 
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
module
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IGridItemModel
COLUMN_SLOT, ROW_SLOT, SLOT_COUNT
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IReportItemModel
BOOKMARK_PROP, DATA_SET_PROP, HEIGHT_PROP, ON_CREATE_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, PARAM_BINDINGS_PROP, TOC_PROP, VISIBILITY_PROP, WIDTH_PROP, X_PROP, Y_PROP
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel
STYLE_PROP
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP
 
Constructor Summary
GridHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
          Constructs a grid handle with the given design and the design element.
 
Method Summary
 boolean canCopyColumn(int columnIndex)
          Copies a column and cells under it with the given column number.
 boolean canInsertAndPasteColumn(ColumnBandData data, int columnIndex)
          Checks whether the insert and paste operation can be done with the given copied column band data, the column index and the operation flag.
 boolean canPasteColumn(ColumnBandData data, int columnIndex, boolean inForce)
          Checks whether the paste operation can be done with the given copied column band data, the column index and the operation flag.
 boolean canShiftColumn(int sourceColumn, int destColumn)
          Moves the column from sourceColumn to destColumn.
 ColumnBandData copyColumn(int columnIndex)
          Copies a column and cells under it with the given column number.
 CellHandle getCell(int row, int column)
          Gets the cell at the position where the given row and column intersect.
 SlotHandle getCellContent(int row, int column)
          Gets the content slot handle of the cell at the position where the given row and column intersect.
 int getColumnCount()
          Returns the number of columns in the Grid.
 SlotHandle getColumns()
          Returns a slot handle for the columns in the grid.
 SlotHandle getRows()
          Returns a slot handle for the rows in the grid.
 void insertAndPasteColumn(ColumnBandData data, int columnNumber)
          Inserts and pastes a column with its cells to the given column number.
 void pasteColumn(ColumnBandData data, int columnNumber, boolean inForce)
          Pastes a column with its cells to the given column number.
 void shiftColumn(int sourceColumn, int destColumn)
          Moves the column from sourceColumn to destIndex.
 
Methods inherited from class org.eclipse.birt.report.model.api.ReportItemHandle
getBookmark, getDataSet, getHeight, getOnCreate, getOnPrepare, getOnRender, getTocExpression, getWidth, getX, getY, paramBindingsIterator, setBookmark, setDataSet, setHeight, setHeight, setOnCreate, setOnPrepare, setOnRender, setTocExpression, setWidth, setWidth, setX, setX, setY, setY, visibilityRulesIterator
 
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask
 
Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
addElement, addElement, addListener, addUserPropertyDefn, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerSlotHandle, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExtends, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getID, getIntProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, isTemplateParameterValue, isValid, localize, moveTo, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setEventHandlerClass, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, showError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GridHandle

public GridHandle(org.eclipse.birt.report.model.core.Module module,
                  org.eclipse.birt.report.model.core.DesignElement element)
Constructs a grid handle with the given design and the design element. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.

Parameters:
module - the module
element - the model representation of the element
Method Detail

getColumns

public SlotHandle getColumns()
Returns a slot handle for the columns in the grid.

Returns:
a handle to the column slot
See Also:
SlotHandle

getRows

public SlotHandle getRows()
Returns a slot handle for the rows in the grid.

Returns:
a handle to the row slot
See Also:
SlotHandle

getColumnCount

public int getColumnCount()
Returns the number of columns in the Grid. The number is defined as the sum of columns described in the "column" slot.

Returns:
the number of columns in the grid.

getCell

public CellHandle getCell(int row,
                          int column)
Gets the cell at the position where the given row and column intersect.

Parameters:
row - the row position indexing from 1
column - the column position indexing from 1
Returns:
the cell handle at the position if the cell exists, otherwise null

getCellContent

public SlotHandle getCellContent(int row,
                                 int column)
Gets the content slot handle of the cell at the position where the given row and column intersect.

Parameters:
row - the row position indexing from 1
column - the column position indexing from 1
Returns:
the content slot handle of the cell at the position if the cell exists, otherwise null

canCopyColumn

public boolean canCopyColumn(int columnIndex)
Copies a column and cells under it with the given column number.

Parameters:
columnIndex - the column position indexing from 1.
Returns:
true if this column band can be copied. Otherwise false.

copyColumn

public ColumnBandData copyColumn(int columnIndex)
                          throws SemanticException
Copies a column and cells under it with the given column number.

Parameters:
columnIndex - the column number
Returns:
a new GridColumnBandAdapter instance
Throws:
SemanticException - if the cell layout of the column is invalid.

pasteColumn

public void pasteColumn(ColumnBandData data,
                        int columnNumber,
                        boolean inForce)
                 throws SemanticException
Pastes a column with its cells to the given column number.

Parameters:
data - the data of a column band to paste
columnNumber - the column index from 1 to the number of columns in the grid
inForce - true if pastes the column regardless of the warning. Otherwise false.
Throws:
SemanticException

canPasteColumn

public boolean canPasteColumn(ColumnBandData data,
                              int columnIndex,
                              boolean inForce)
Checks whether the paste operation can be done with the given copied column band data, the column index and the operation flag.

Parameters:
data - the column band data to paste
columnIndex - the column index from 1 to the number of columns in the grid
inForce - true indicates to paste the column regardless of the different layout of cells. false indicates not.
Returns:
true indicates the paste operation can be done. Otherwise false.

insertAndPasteColumn

public void insertAndPasteColumn(ColumnBandData data,
                                 int columnNumber)
                          throws SemanticException
Inserts and pastes a column with its cells to the given column number.

Parameters:
data - the data of a column band to paste
columnNumber - the column index from 0 to the number of columns in the grid
Throws:
SemanticException

canInsertAndPasteColumn

public boolean canInsertAndPasteColumn(ColumnBandData data,
                                       int columnIndex)
Checks whether the insert and paste operation can be done with the given copied column band data, the column index and the operation flag. This is different from canPasteColumn since this action creates an extra column for the table.

Parameters:
data - the column band data to paste
columnIndex - the column index from 0 to the number of columns in the grid
Returns:
true indicates the paste operation can be done. Otherwise false.

shiftColumn

public void shiftColumn(int sourceColumn,
                        int destColumn)
                 throws SemanticException
Moves the column from sourceColumn to destIndex.

Parameters:
sourceColumn - the source column ranging from 1 to the column number
destColumn - the target column ranging from 0 to the column number
Throws:
SemanticException - if the chosen column band is forbidden to shift

canShiftColumn

public boolean canShiftColumn(int sourceColumn,
                              int destColumn)
Moves the column from sourceColumn to destColumn.

Parameters:
sourceColumn - the source column ranging from 1 to the column number
destColumn - the target column ranging from 0 to the column number
Returns:
true if the chosen column band is legal to shift. Otherwise false.


Copyright © 2005 Actuate Corp. All rights reserved.