public interface Block extends IChartObject
The most important block is the chart's block, all contents of a chart
are rendered inside this block, we can get the instance of a chart's block using:
Chart.getBlock( );
The following features are supported:
LayoutPackage.getBlock()
Modifier and Type | Method and Description |
---|---|
void |
add(Block bl)
Adds a block into the children hierarchy
|
java.util.Enumeration<Block> |
children(boolean bRecursive) |
Block |
copyInstance() |
Anchor |
getAnchor()
Returns the value of the 'Anchor' attribute.
|
Fill |
getBackground()
Returns the value of the 'Background' containment
reference.
|
Bounds |
getBounds()
Returns the value of the 'Bounds' containment
reference.
|
org.eclipse.emf.common.util.EList<Block> |
getChildren()
Returns the value of the 'Children' containment reference list.
|
int |
getColumn()
Returns the value of the 'Column' attribute.
|
int |
getColumnspan()
Returns the value of the 'Columnspan' attribute.
|
Cursor |
getCursor()
Returns the value of the 'Cursor' containment reference.
|
double |
getHeightHint()
Returns the value of the 'Height Hint' attribute.
|
Insets |
getInsets()
Returns the value of the 'Insets' containment
reference.
|
Size |
getMinSize()
Returns the value of the 'Min Size' containment
reference.
|
LineAttributes |
getOutline()
Returns the value of the 'Outline' containment
reference.
|
Size |
getPreferredSize(IDisplayServer xs,
Chart cm,
RunTimeContext rtc)
Computes and returns the size of the title block based on the text
content and its attributes
|
int |
getRow()
Returns the value of the 'Row' attribute.
|
int |
getRowspan()
Returns the value of the 'Rowspan' attribute.
|
Stretch |
getStretch()
Returns the value of the 'Stretch' attribute.
|
org.eclipse.emf.common.util.EList<Trigger> |
getTriggers()
Returns the value of the 'Triggers' containment
reference list.
|
double |
getWidthHint()
Returns the value of the 'Width Hint' attribute.
|
boolean |
isCustom() |
boolean |
isLegend() |
boolean |
isPlot() |
boolean |
isSetAnchor()
Returns whether the value of the '
Anchor ' attribute is set. |
boolean |
isSetColumn()
Returns whether the value of the '
Column ' attribute is set. |
boolean |
isSetColumnspan()
Returns whether the value of the '
Columnspan ' attribute is set. |
boolean |
isSetHeightHint()
Returns whether the value of the '
Height Hint ' attribute is set. |
boolean |
isSetRow()
Returns whether the value of the '
Row ' attribute is set. |
boolean |
isSetRowspan()
Returns whether the value of the '
Rowspan ' attribute is set. |
boolean |
isSetStretch()
Returns whether the value of the '
Stretch ' attribute is set. |
boolean |
isSetVisible()
Returns whether the value of the '
Visible ' attribute is set. |
boolean |
isSetWidthHint()
Returns whether the value of the '
Width Hint ' attribute is set. |
boolean |
isText() |
boolean |
isTitle() |
boolean |
isVisible()
Returns the value of the 'Visible' attribute.
|
void |
remove(Block bl)
Removes a block from the children hierarchy
|
void |
setAnchor(Anchor value)
Sets the value of the '
Anchor ' attribute. |
void |
setBackground(Fill value)
Sets the value of the '
Background ' containment reference. |
void |
setBounds(Bounds value)
Sets the value of the '
Bounds ' containment reference. |
void |
setColumn(int value)
Sets the value of the '
Column ' attribute. |
void |
setColumnspan(int value)
Sets the value of the '
Columnspan ' attribute. |
void |
setCursor(Cursor value)
Sets the value of the '
Cursor ' containment reference. |
void |
setHeightHint(double value)
Sets the value of the '
Height Hint ' attribute. |
void |
setInsets(Insets value)
Sets the value of the '
Insets ' containment reference. |
void |
setMinSize(Size value)
Sets the value of the '
Min Size ' containment reference. |
void |
setOutline(LineAttributes value)
Sets the value of the '
Outline ' containment reference. |
void |
setRow(int value)
Sets the value of the '
Row ' attribute. |
void |
setRowspan(int value)
Sets the value of the '
Rowspan ' attribute. |
void |
setStretch(Stretch value)
Sets the value of the '
Stretch ' attribute. |
void |
setVisible(boolean value)
Sets the value of the '
Visible ' attribute. |
void |
setWidthHint(double value)
Sets the value of the '
Width Hint ' attribute. |
void |
unsetAnchor()
Unsets the value of the '
Anchor ' attribute. |
void |
unsetColumn()
Unsets the value of the '
Column ' attribute. |
void |
unsetColumnspan()
Unsets the value of the '
Columnspan ' attribute. |
void |
unsetHeightHint()
Unsets the value of the '
Height Hint ' attribute. |
void |
unsetRow()
Unsets the value of the '
Row ' attribute. |
void |
unsetRowspan()
Unsets the value of the '
Rowspan ' attribute. |
void |
unsetStretch()
Unsets the value of the '
Stretch ' attribute. |
void |
unsetVisible()
Unsets the value of the '
Visible ' attribute. |
void |
unsetWidthHint()
Unsets the value of the '
Width Hint ' attribute. |
org.eclipse.emf.common.util.EList<Block> getChildren()
Block
.
Gets the blocks contained within this block. LayoutPackage.getBlock_Children()
Bounds getBounds()
setBounds(Bounds)
,
LayoutPackage.getBlock_Bounds()
void setBounds(Bounds value)
Bounds
' containment reference.
value
- the new value of the 'Bounds' containment reference.getBounds()
Anchor getAnchor()
"North"
. The literals are from the
enumeration Anchor
.
Specifies where the content of the block is anchored.
Anchor
,
isSetAnchor()
,
unsetAnchor()
,
setAnchor(Anchor)
,
LayoutPackage.getBlock_Anchor()
void setAnchor(Anchor value)
Anchor
' attribute.
value
- the new value of the 'Anchor' attribute.Anchor
,
isSetAnchor()
,
unsetAnchor()
,
getAnchor()
void unsetAnchor()
Anchor
' attribute.
isSetAnchor()
,
getAnchor()
,
setAnchor(Anchor)
boolean isSetAnchor()
Anchor
' attribute is set.
unsetAnchor()
,
getAnchor()
,
setAnchor(Anchor)
Stretch getStretch()
"Horizontal"
. The literals are from the
enumeration Stretch
.
Specifies how the content of the block fills up available space.
Stretch
,
isSetStretch()
,
unsetStretch()
,
setStretch(Stretch)
,
LayoutPackage.getBlock_Stretch()
void setStretch(Stretch value)
Stretch
' attribute.
value
- the new value of the 'Stretch' attribute.Stretch
,
isSetStretch()
,
unsetStretch()
,
getStretch()
void unsetStretch()
Stretch
' attribute.
isSetStretch()
,
getStretch()
,
setStretch(Stretch)
boolean isSetStretch()
Stretch
' attribute is set.
unsetStretch()
,
getStretch()
,
setStretch(Stretch)
Insets getInsets()
setInsets(Insets)
,
LayoutPackage.getBlock_Insets()
void setInsets(Insets value)
Insets
' containment reference.
value
- the new value of the 'Insets' containment reference.getInsets()
int getRow()
isSetRow()
,
unsetRow()
,
setRow(int)
,
LayoutPackage.getBlock_Row()
void setRow(int value)
Row
' attribute.
value
- the new value of the 'Row' attribute.isSetRow()
,
unsetRow()
,
getRow()
void unsetRow()
Row
' attribute.
isSetRow()
,
getRow()
,
setRow(int)
boolean isSetRow()
Row
' attribute is set.
unsetRow()
,
getRow()
,
setRow(int)
int getColumn()
isSetColumn()
,
unsetColumn()
,
setColumn(int)
,
LayoutPackage.getBlock_Column()
void setColumn(int value)
Column
' attribute.
value
- the new value of the 'Column' attribute.isSetColumn()
,
unsetColumn()
,
getColumn()
void unsetColumn()
Column
' attribute.
isSetColumn()
,
getColumn()
,
setColumn(int)
boolean isSetColumn()
Column
' attribute is set.
unsetColumn()
,
getColumn()
,
setColumn(int)
int getRowspan()
isSetRowspan()
,
unsetRowspan()
,
setRowspan(int)
,
LayoutPackage.getBlock_Rowspan()
void setRowspan(int value)
Rowspan
' attribute.
value
- the new value of the 'Rowspan' attribute.isSetRowspan()
,
unsetRowspan()
,
getRowspan()
void unsetRowspan()
Rowspan
' attribute.
isSetRowspan()
,
getRowspan()
,
setRowspan(int)
boolean isSetRowspan()
Rowspan
' attribute is set.
unsetRowspan()
,
getRowspan()
,
setRowspan(int)
int getColumnspan()
isSetColumnspan()
,
unsetColumnspan()
,
setColumnspan(int)
,
LayoutPackage.getBlock_Columnspan()
void setColumnspan(int value)
Columnspan
' attribute.
value
- the new value of the 'Columnspan' attribute.isSetColumnspan()
,
unsetColumnspan()
,
getColumnspan()
void unsetColumnspan()
Columnspan
' attribute.
isSetColumnspan()
,
getColumnspan()
,
setColumnspan(int)
boolean isSetColumnspan()
Columnspan
' attribute is set.
unsetColumnspan()
,
getColumnspan()
,
setColumnspan(int)
Size getMinSize()
setMinSize(Size)
,
LayoutPackage.getBlock_MinSize()
void setMinSize(Size value)
Min Size
' containment reference.
value
- the new value of the 'Min Size' containment reference.getMinSize()
LineAttributes getOutline()
setOutline(LineAttributes)
,
LayoutPackage.getBlock_Outline()
void setOutline(LineAttributes value)
Outline
' containment reference.
value
- the new value of the 'Outline' containment reference.getOutline()
Fill getBackground()
setBackground(Fill)
,
LayoutPackage.getBlock_Background()
void setBackground(Fill value)
Background
' containment reference.
value
- the new value of the 'Background' containment reference.getBackground()
boolean isVisible()
isSetVisible()
,
unsetVisible()
,
setVisible(boolean)
,
LayoutPackage.getBlock_Visible()
void setVisible(boolean value)
Visible
' attribute.
value
- the new value of the 'Visible' attribute.isSetVisible()
,
unsetVisible()
,
isVisible()
void unsetVisible()
Visible
' attribute.
isSetVisible()
,
isVisible()
,
setVisible(boolean)
boolean isSetVisible()
Visible
' attribute is set.
unsetVisible()
,
isVisible()
,
setVisible(boolean)
org.eclipse.emf.common.util.EList<Trigger> getTriggers()
Trigger
.
Holds the actions for the block.
LayoutPackage.getBlock_Triggers()
double getWidthHint()
"-1"
.
WidthHint specifies a hinted width for the block.
isSetWidthHint()
,
unsetWidthHint()
,
setWidthHint(double)
,
LayoutPackage.getBlock_WidthHint()
void setWidthHint(double value)
Width Hint
' attribute.
value
- the new value of the 'Width Hint' attribute.isSetWidthHint()
,
unsetWidthHint()
,
getWidthHint()
void unsetWidthHint()
Width Hint
' attribute.
isSetWidthHint()
,
getWidthHint()
,
setWidthHint(double)
boolean isSetWidthHint()
Width Hint
' attribute is set.
unsetWidthHint()
,
getWidthHint()
,
setWidthHint(double)
double getHeightHint()
"-1"
.
HeightHint pecifies a hinted height for the block.
isSetHeightHint()
,
unsetHeightHint()
,
setHeightHint(double)
,
LayoutPackage.getBlock_HeightHint()
void setHeightHint(double value)
Height Hint
' attribute.
value
- the new value of the 'Height Hint' attribute.isSetHeightHint()
,
unsetHeightHint()
,
getHeightHint()
void unsetHeightHint()
Height Hint
' attribute.
isSetHeightHint()
,
getHeightHint()
,
setHeightHint(double)
boolean isSetHeightHint()
Height Hint
' attribute is set.
unsetHeightHint()
,
getHeightHint()
,
setHeightHint(double)
Cursor getCursor()
setCursor(Cursor)
,
LayoutPackage.getBlock_Cursor()
void setCursor(Cursor value)
Cursor
' containment reference.
value
- the new value of the 'Cursor' containment reference.getCursor()
java.util.Enumeration<Block> children(boolean bRecursive)
bRecursive
- Size getPreferredSize(IDisplayServer xs, Chart cm, RunTimeContext rtc) throws ChartException
xs
- The Xserver used in computing the scaling factor (pixels =>
points)cm
- The chart model instance (if needed)rtc
- GenerationException
ChartException
boolean isCustom()
boolean isPlot()
boolean isLegend()
boolean isText()
boolean isTitle()
void add(Block bl)
bl
- void remove(Block bl)
bl
- Block copyInstance()
copyInstance
in interface IChartObject
Copyright © 2005-2008 Actuate Corp. All rights reserved.