|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.CellHandle
public class CellHandle
Represents a cell within a table or grid. A cell can span multiple rows and/or columns. A cell can contain zero, one or many contents. However, since BIRT will position multiple items automatically, the application should generally provide its own container if the cell is to hold multiple items.
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()
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.ICellModel |
---|
ANTIDIAGONAL_NUMBER_PROP, ANTIDIAGONAL_STYLE_PROP, ANTIDIAGONAL_THICKNESS_PROP, COL_SPAN_PROP, COLUMN_PROP, CONTENT_SLOT, DIAGONAL_NUMBER_PROP, DIAGONAL_STYLE_PROP, DIAGONAL_THICKNESS_PROP, DROP_PROP, HEIGHT_PROP, ON_CREATE_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, ROW_SPAN_PROP, STYLE_PROP, WIDTH_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, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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. |
int |
getColumn()
Returns the cell's column property. |
int |
getColumnSpan()
Returns the cell's column span. |
SlotHandle |
getContent()
Returns the contents of the cell. |
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 |
getEventHandleClass()
Gets a string that defines the event handle class. |
DimensionHandle |
getHeight()
Returns the cell's height. |
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. |
DimensionHandle |
getWidth()
Returns the cell's width. |
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 |
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 |
setEventHandleClass(java.lang.String expr)
Sets the group expression. |
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. |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public 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 elementMethod Detail |
---|
public int getColumnSpan()
public void setColumnSpan(int span) throws SemanticException
span
- the column span
SemanticException
- if this property is locked.public int getRowSpan()
public void setRowSpan(int span) throws SemanticException
span
- the row span
SemanticException
- 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 property
SemanticException
- 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 set
SemanticException
- if the method is locked.getOnPrepare()
public void setOnCreate(java.lang.String script) throws SemanticException
script
- the script to set
SemanticException
- if the method is locked.getOnCreate()
public void setOnRender(java.lang.String script) throws SemanticException
script
- the script to set
SemanticException
- if the method is locked.getOnRender()
public java.lang.String getEventHandleClass()
setEventHandleClass(String)
public void setEventHandleClass(java.lang.String expr) throws SemanticException
expr
- the expression to set
SemanticException
- If the expression is invalid.getEventHandleClass()
public void setDiagonalNumber(int diagonalNumber) throws SemanticException
diagonalNumber
- the diagonal number
SemanticException
public 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 void setAntidiagonalNumber(int antidiagonalNumber) throws SemanticException
antidiagonalNumber
- the anti-diagonal number
SemanticException
public 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |