public class CellHandle extends ReportElementHandle implements org.eclipse.birt.report.model.elements.interfaces.ICellModel
The application generally does not create cell handles directly. Instead, it
uses one of the navigation methods available on other element handles such as
RowHandle.
Cell,
RowHandle.getCells()elementmoduleALT_TEXT_KEY_PROP, ALT_TEXT_PROP, ANTIDIAGONAL_COLOR_PROP, ANTIDIAGONAL_NUMBER_PROP, ANTIDIAGONAL_STYLE_PROP, ANTIDIAGONAL_THICKNESS_PROP, BOOKMARK_DISPLAY_NAME_PROP, BOOKMARK_PROP, COL_SPAN_PROP, COLUMN_PROP, CONTENT_SLOT, DIAGONAL_COLOR_PROP, DIAGONAL_NUMBER_PROP, DIAGONAL_STYLE_PROP, DIAGONAL_THICKNESS_PROP, DROP_PROP, HEADERS_PROP, HEIGHT_PROP, LANGUAGE_PROP, ON_CREATE_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, ROW_SPAN_PROP, SCOPE_PROP, STYLE_PROP, TAG_TYPE_PROP, WIDTH_PROPCOMMENTS_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| 构造器和说明 |
|---|
CellHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle for the given design and design element.
|
| 限定符和类型 | 方法和说明 |
|---|---|
ExpressionHandle |
getAltTextExpression()
Returns the alternate text of this label item.
|
java.lang.String |
getAltTextKey()
Returns the resource key of the alternate text of this image.
|
ColorHandle |
getAntidiagonalColor()
Gets a color handle to deal with the color of the anti-diagonal.
|
int |
getAntidiagonalNumber()
Gets the number of the anti-diagonal lines that are from the top-right to
bottom-left.
|
java.lang.String |
getAntidiagonalStyle()
Returns the style of the anti-diagonal that is from top-right to
bottom-left corner.
|
DimensionHandle |
getAntidiagonalThickness()
Gets a dimension handle to deal with the anti-diagonal thickness.
|
java.lang.String |
getBookmark()
Gets the book mark value on the cell element.
|
java.lang.String |
getBookmarkDisplayName()
Gets the display name of the bookmark.
|
int |
getColumn()
Returns the cell's column property.
|
int |
getColumnSpan()
Returns the cell's column span.
|
SlotHandle |
getContent()
Returns the contents of the cell.
|
ColorHandle |
getDiagonalColor()
Gets a color handle to deal with the color of the diagonal.
|
int |
getDiagonalNumber()
Gets the number of the diagonal lines that are from top-left to
bottom-right corners.
|
java.lang.String |
getDiagonalStyle()
Returns the style of the diagonal that is from top-left to bottom-right.
|
DimensionHandle |
getDiagonalThickness()
Gets a dimension handle to deal with the diagonal thickness.
|
java.lang.String |
getDrop()
Returns the cell's drop property.
|
java.lang.String |
getHeaders()
Gets the headers value on the cell element.
|
DimensionHandle |
getHeight()
Returns the cell's height.
|
java.lang.String |
getLanguage()
Returns the language of this label item.
|
java.lang.String |
getOnCreate()
Gets the on-finish script of the group.
|
java.lang.String |
getOnPrepare()
Gets the on-prepare script of the group.
|
java.lang.String |
getOnRender()
Gets the on-finish script of the group.
|
int |
getRowSpan()
Returns the cell's row span.
|
java.lang.String |
getScope()
Gets the scope value of the cell.The return value is one of the constants
defined in
DesignChoiceConstants:
SCOPE_TYPE_ROW
SCOPE_TYPE_COL
SCOPE_TYPE_ROWGROUP
SCOPE_TYPE_COLGROUP
|
java.lang.String |
getTagType()
Returns the tag type of this label item.
|
DimensionHandle |
getWidth()
Returns the cell's width.
|
void |
setAltTextExpression(Expression altText)
Sets the alternate text of this label item.
|
void |
setAltTextKey(java.lang.String altTextKey)
Sets the resource key of the alternate text of this image.
|
void |
setAntidiagonalNumber(int antidiagonalNumber)
Sets the number of the anti-diagonal lines that are from the top-right to
bottom-left.
|
void |
setAntidiagonalStyle(java.lang.String antidiagonalStyle)
Sets the style of the anti-diagonal that is from top-right to bottom-left
corner.
|
void |
setBookmark(java.lang.String bookmark)
Sets the book mark value on the cell element.
|
void |
setBookmarkDisplayName(java.lang.String bookmarkDisplayName)
Sets the display name of the bookmark.
|
void |
setColumn(int column)
Sets the cell's column property.
|
void |
setColumnSpan(int span)
Sets the cell's column span.
|
void |
setDiagonalNumber(int diagonalNumber)
Sets the number of the diagonal lines that are from top-left to
bottom-right corners.
|
void |
setDiagonalStyle(java.lang.String lineStyle)
Sets the style of the diagonal that is from top-left to bottom-right.
|
void |
setDrop(java.lang.String drop)
Sets the cell's drop property.
|
void |
setHeaders(java.lang.String headers)
Sets the headers value on the cell element.
|
void |
setLanguage(java.lang.String language)
Sets the language of this label item.
|
void |
setOnCreate(java.lang.String script)
Sets the on-create script of the group element.
|
void |
setOnPrepare(java.lang.String script)
Sets the on-prepare script of the group element.
|
void |
setOnRender(java.lang.String script)
Sets the on-render script of the group element.
|
void |
setRowSpan(int span)
Sets the cell's row span.
|
void |
setScope(java.lang.String scope)
Sets the scope value of the cell.The input value is one of the constants
defined in
DesignChoiceConstants:
SCOPE_TYPE_ROW
SCOPE_TYPE_COL
SCOPE_TYPE_ROWGROUP
SCOPE_TYPE_COLGROUP
|
void |
setTagType(java.lang.String tagType)
Sets the tag type of this label item.
|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMaskadd, 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, 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, slotsIteratorpublic CellHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
module - the moduleelement - the model representation of the elementpublic int getColumnSpan()
public void setColumnSpan(int span)
throws SemanticException
span - the column spanSemanticException - if this property is locked.public int getRowSpan()
public void setRowSpan(int span)
throws SemanticException
span - the row spanSemanticException - if this property is locked.public java.lang.String getDrop()
setDrop(String)public void setDrop(java.lang.String drop)
throws SemanticException
DesignChoiceConstants and can be one of:
Note that This property is valid only for cells within a table; but not for cells within a grid.
drop - the string value of the drop propertySemanticException - if the property is locked or the input value is not one of
the above.getDrop()public SlotHandle getContent()
public int getColumn()
public void setColumn(int column)
throws SemanticException
column - the column index, starting from 1.SemanticException - if this property is locked.public DimensionHandle getHeight()
public DimensionHandle getWidth()
public java.lang.String getOnPrepare()
public java.lang.String getOnCreate()
public java.lang.String getOnRender()
public void setOnPrepare(java.lang.String script)
throws SemanticException
script - the script to setSemanticException - if the method is locked.getOnPrepare()public void setOnCreate(java.lang.String script)
throws SemanticException
script - the script to setSemanticException - if the method is locked.getOnCreate()public void setOnRender(java.lang.String script)
throws SemanticException
script - the script to setSemanticException - if the method is locked.getOnRender()public void setDiagonalNumber(int diagonalNumber)
throws SemanticException
diagonalNumber - the diagonal numberSemanticExceptionpublic int getDiagonalNumber()
public DimensionHandle getDiagonalThickness()
DesignChoiceConstatns:
LINE_WIDTH_THIN
LINE_WIDTH_MEDIUM
LINE_WIDTH_THICK
public void setDiagonalStyle(java.lang.String lineStyle)
throws SemanticException
DesignChoiceConstants:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
lineStyle - the line style.SemanticException - if the input value is not one of the above values.public java.lang.String getDiagonalStyle()
DesignChoiceConstants:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
public ColorHandle getDiagonalColor()
public void setAntidiagonalNumber(int antidiagonalNumber)
throws SemanticException
antidiagonalNumber - the anti-diagonal numberSemanticExceptionpublic int getAntidiagonalNumber()
public DimensionHandle getAntidiagonalThickness()
DesignChoiceConstatns:
LINE_WIDTH_THIN
LINE_WIDTH_MEDIUM
LINE_WIDTH_THICK
public java.lang.String getAntidiagonalStyle()
DesignChoiceConstants:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
public void setAntidiagonalStyle(java.lang.String antidiagonalStyle)
throws SemanticException
DesignChoiceConstants:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
antidiagonalStyle - the anti-diagonal style.SemanticException - if the input value is not one of the above values.public ColorHandle getAntidiagonalColor()
public void setScope(java.lang.String scope)
throws SemanticException
DesignChoiceConstants:
SCOPE_TYPE_ROWSCOPE_TYPE_COLSCOPE_TYPE_ROWGROUPSCOPE_TYPE_COLGROUPscope - the scopeSemanticException - if the input value is not one of the above values.public java.lang.String getScope()
DesignChoiceConstants:
SCOPE_TYPE_ROWSCOPE_TYPE_COLSCOPE_TYPE_ROWGROUPSCOPE_TYPE_COLGROUPpublic void setBookmark(java.lang.String bookmark)
throws SemanticException
bookmark - the book mark.SemanticException - if this property is locked.public java.lang.String getBookmark()
public java.lang.String getHeaders()
public void setHeaders(java.lang.String headers)
throws SemanticException
headers - the headers value.SemanticException - if this property is locked.public java.lang.String getBookmarkDisplayName()
public void setBookmarkDisplayName(java.lang.String bookmarkDisplayName)
throws SemanticException
bookmarkDisplayName - the display name of the bookmark to setSemanticExceptionpublic java.lang.String getTagType()
public void setTagType(java.lang.String tagType)
throws SemanticException
tag - type
the tag typeSemanticException - if the property is locked.public java.lang.String getLanguage()
public void setLanguage(java.lang.String language)
throws SemanticException
language - the languageSemanticException - if the property is locked.public ExpressionHandle getAltTextExpression()
public void setAltTextExpression(Expression altText) throws SemanticException
altText - the alternate text expression.SemanticException - if the property is locked.public java.lang.String getAltTextKey()
public void setAltTextKey(java.lang.String altTextKey)
throws SemanticException
altTextKey - the alternate text keySemanticExceptionCopyright © 2008 Actuate Corp. All rights reserved.