Class RowHandle
java.lang.Object
org.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.RowHandle
- All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
,org.eclipse.birt.report.model.elements.interfaces.ITableRowModel
public class RowHandle
extends ReportElementHandle
implements org.eclipse.birt.report.model.elements.interfaces.ITableRowModel
Represents one row in a Grid or Table. Each row contains some number of
cells. And one row can define its height.
- See Also:
-
TableRow
-
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.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, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.ITableRowModel
BOOKMARK_DISPLAY_NAME_PROP, BOOKMARK_PROP, CONTENT_SLOT, HEIGHT_PROP, LANGUAGE_PROP, ON_CREATE_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, REPEATABLE_PROP, STYLE_PROP, SUPPRESS_DUPLICATES_PROP, TAG_TYPE_PROP, VISIBILITY_PROP
-
Constructor Summary
ConstructorsConstructorDescriptionRowHandle
(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Constructs the handle for a row with the given design and element. -
Method Summary
Modifier and TypeMethodDescriptionReturns the bookmark of this row.Gets the display name of the bookmark.getCells()
Returns the cell slot of row.Gets a handle to deal with the row's height.Returns the language of this label item.Gets the on-finish script of the group.Gets the on-prepare script of the group.Gets the on-finish script of the group.boolean
Gets repeatable value.void
setBookmark
(String value) Sets the bookmark of this row.void
setBookmarkDisplayName
(String bookmarkDisplayName) Sets the display name of the bookmark.void
setLanguage
(String language) Sets the language of this label item.void
setOnCreate
(String script) Sets the on-create script of the group element.void
setOnPrepare
(String script) Sets the on-prepare script of the group element.void
setOnRender
(String script) Sets the on-render script of the group element.void
setRepeatable
(boolean repeatable) Sets the repeatable value.void
setSuppressDuplicates
(boolean value) Sets the flag whether to suppress duplicates rows with same content.void
setTagType
(String tagType) Sets the tag type of this label item.boolean
Tests whether to suppress duplicates rows with same content.Returns visibility rules defined on the table row.Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask
Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
add, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getTagType, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIterator
-
Constructor Details
-
RowHandle
public RowHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Constructs the handle for a row with the given design and 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 moduleelement
- the model representation of the element
-
-
Method Details
-
getCells
Returns the cell slot of row. Through SlotHandle, each cell can be obtained.- Returns:
- the handle to the cell slot
- See Also:
-
getHeight
Gets a handle to deal with the row's height.- Returns:
- a DimensionHandle for the row's height.
-
getBookmark
Returns the bookmark of this row.- Returns:
- the bookmark of this row
-
setBookmark
Sets the bookmark of this row.- Parameters:
value
- the bookmark to set- Throws:
SemanticException
- if the property is locked.
-
visibilityRulesIterator
Returns visibility rules defined on the table row. The element in the iterator is the correspondingStructureHandle
that deal with aHide
in the list.- Returns:
- the iterator for visibility rules defined on this row.
- See Also:
-
getOnPrepare
Gets the on-prepare script of the group. Startup phase. No data binding yet. The design of an element can be changed here.- Returns:
- the on-prepare script of the group
-
getOnCreate
Gets the on-finish script of the group. Presentation phase. The report item has been read from the report document, but not sent to emitter yet.- Returns:
- the on-finish script of the group
-
getOnRender
Gets the on-finish script of the group. Presentation phase. The report item has been read from the report document, but not sent to emitter yet.- Returns:
- the on-finish script of the group
-
setOnPrepare
Sets the on-prepare script of the group element.- Parameters:
script
- the script to set- Throws:
SemanticException
- if the method is locked.- See Also:
-
setOnCreate
Sets the on-create script of the group element.- Parameters:
script
- the script to set- Throws:
SemanticException
- if the method is locked.- See Also:
-
setOnRender
Sets the on-render script of the group element.- Parameters:
script
- the script to set- Throws:
SemanticException
- if the method is locked.- See Also:
-
suppressDuplicates
public boolean suppressDuplicates()Tests whether to suppress duplicates rows with same content.- Returns:
true
if suppress duplicates rows with same content, otherwisefalse
.- See Also:
-
setSuppressDuplicates
Sets the flag whether to suppress duplicates rows with same content.- Parameters:
value
-true
if suppress duplicates rows with same content, otherwisefalse
.- Throws:
SemanticException
- If the expression is invalid.- See Also:
-
repeatable
public boolean repeatable()Gets repeatable value. This property is used to control the output of a row is repeated on every page or just once.- Returns:
- the repeatable value.
-
setRepeatable
Sets the repeatable value. This property is used to control the output of a row is repeated on every page or just once.- Parameters:
repeatable
- the repeatable value.- Throws:
SemanticException
- if this value is locked.
-
getBookmarkDisplayName
Gets the display name of the bookmark.- Returns:
- the display name of the bookmark.
-
setBookmarkDisplayName
Sets the display name of the bookmark.- Parameters:
bookmarkDisplayName
- the display name of the bookmark to set- Throws:
SemanticException
-
setTagType
Sets the tag type of this label item.- Parameters:
tag
- type the tag type- Throws:
SemanticException
- if the property is locked.
-
getLanguage
Returns the language of this label item.- Returns:
- the language
-
setLanguage
Sets the language of this label item.- Parameters:
language
- the language- Throws:
SemanticException
- if the property is locked.
-