|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A representation of the model object 'Legend'. The Legend in a chart.
The following features are supported:
Horizontal Spacing
Vertical Spacing
Client Area
Text
Orientation
Direction
Separator
Position
Item Type
Title
Title Position
Show Value
Show Percent
Show Total
Wrapping Size
LayoutPackage.getLegend()
Method Summary | |
ClientArea |
getClientArea()
Returns the value of the 'Client Area' containment reference. |
Direction |
getDirection()
Returns the value of the 'Direction' attribute. |
int |
getHorizontalSpacing()
Returns the value of the 'Horizontal Spacing' attribute. |
LegendItemType |
getItemType()
Returns the value of the 'Item Type' attribute. |
Orientation |
getOrientation()
Returns the value of the 'Orientation' attribute. |
Position |
getPosition()
Returns the value of the 'Position' attribute. |
LineAttributes |
getSeparator()
Returns the value of the 'Separator' containment reference. |
Text |
getText()
Returns the value of the 'Text' containment reference. |
Label |
getTitle()
Returns the value of the 'Title' containment reference. |
Position |
getTitlePosition()
Returns the value of the 'Title Position' attribute. |
int |
getVerticalSpacing()
Returns the value of the 'Vertical Spacing' attribute. |
double |
getWrappingSize()
Returns the value of the 'Wrapping Size' attribute. |
boolean |
isSetDirection()
Returns whether the value of the ' Direction ' attribute is set. |
boolean |
isSetHorizontalSpacing()
Returns whether the value of the ' Horizontal Spacing ' attribute is set. |
boolean |
isSetItemType()
Returns whether the value of the ' Item Type ' attribute is set. |
boolean |
isSetOrientation()
Returns whether the value of the ' Orientation ' attribute is set. |
boolean |
isSetPosition()
Returns whether the value of the ' Position ' attribute is set. |
boolean |
isSetShowPercent()
Returns whether the value of the ' Show Percent ' attribute is set. |
boolean |
isSetShowTotal()
Returns whether the value of the ' Show Total ' attribute is set. |
boolean |
isSetShowValue()
Returns whether the value of the ' Show Value ' attribute is set. |
boolean |
isSetTitlePosition()
Returns whether the value of the ' Title Position ' attribute is set. |
boolean |
isSetVerticalSpacing()
Returns whether the value of the ' Vertical Spacing ' attribute is set. |
boolean |
isSetWrappingSize()
Returns whether the value of the ' Wrapping Size ' attribute is set. |
boolean |
isShowPercent()
Returns the value of the 'Show Percent' attribute. |
boolean |
isShowTotal()
Returns the value of the 'Show Total' attribute. |
boolean |
isShowValue()
Returns the value of the 'Show Value' attribute. |
void |
setClientArea(ClientArea value)
Sets the value of the ' Client Area ' containment reference. |
void |
setDirection(Direction value)
Sets the value of the ' Direction ' attribute. |
void |
setHorizontalSpacing(int value)
Sets the value of the ' Horizontal Spacing ' attribute. |
void |
setItemType(LegendItemType value)
Sets the value of the ' Item Type ' attribute. |
void |
setOrientation(Orientation value)
Sets the value of the ' Orientation ' attribute. |
void |
setPosition(Position value)
Sets the value of the ' Position ' attribute. |
void |
setSeparator(LineAttributes value)
Sets the value of the ' Separator ' containment reference. |
void |
setShowPercent(boolean value)
Sets the value of the ' Show Percent ' attribute. |
void |
setShowTotal(boolean value)
Sets the value of the ' Show Total ' attribute. |
void |
setShowValue(boolean value)
Sets the value of the ' Show Value ' attribute. |
void |
setText(Text value)
Sets the value of the ' Text ' containment reference. |
void |
setTitle(Label value)
Sets the value of the ' Title ' containment reference. |
void |
setTitlePosition(Position value)
Sets the value of the ' Title Position ' attribute. |
void |
setVerticalSpacing(int value)
Sets the value of the ' Vertical Spacing ' attribute. |
void |
setWrappingSize(double value)
Sets the value of the ' Wrapping Size ' attribute. |
void |
unsetDirection()
Unsets the value of the ' Direction ' attribute. |
void |
unsetHorizontalSpacing()
Unsets the value of the ' Horizontal Spacing ' attribute. |
void |
unsetItemType()
Unsets the value of the ' Item Type ' attribute. |
void |
unsetOrientation()
Unsets the value of the ' Orientation ' attribute. |
void |
unsetPosition()
Unsets the value of the ' Position ' attribute. |
void |
unsetShowPercent()
Unsets the value of the ' Show Percent ' attribute. |
void |
unsetShowTotal()
Unsets the value of the ' Show Total ' attribute. |
void |
unsetShowValue()
Unsets the value of the ' Show Value ' attribute. |
void |
unsetTitlePosition()
Unsets the value of the ' Title Position ' attribute. |
void |
unsetVerticalSpacing()
Unsets the value of the ' Vertical Spacing ' attribute. |
void |
unsetWrappingSize()
Unsets the value of the ' Wrapping Size ' attribute. |
void |
updateLayout(Chart cm)
Update the legend's block relationship in the hierarchy w.r.t. |
Methods inherited from interface org.eclipse.birt.chart.model.layout.Block |
add, children, getAnchor, getBackground, getBounds, getChildren, getColumn, getColumnspan, getHeightHint, getInsets, getMinSize, getOutline, getPreferredSize, getRow, getRowspan, getStretch, getTriggers, getWidthHint, isCustom, isLegend, isPlot, isSetAnchor, isSetColumn, isSetColumnspan, isSetHeightHint, isSetRow, isSetRowspan, isSetStretch, isSetVisible, isSetWidthHint, isText, isTitle, isVisible, remove, setAnchor, setBackground, setBounds, setColumn, setColumnspan, setHeightHint, setInsets, setMinSize, setOutline, setRow, setRowspan, setStretch, setVisible, setWidthHint, unsetAnchor, unsetColumn, unsetColumnspan, unsetHeightHint, unsetRow, unsetRowspan, unsetStretch, unsetVisible, unsetWidthHint |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
eAdapters, eDeliver, eNotify, eSetDeliver |
Method Detail |
public int getHorizontalSpacing()
isSetHorizontalSpacing()
,
unsetHorizontalSpacing()
,
setHorizontalSpacing(int)
,
LayoutPackage.getLegend_HorizontalSpacing()
public void setHorizontalSpacing(int value)
Horizontal Spacing
' attribute.
value
- the new value of the 'Horizontal Spacing' attribute.isSetHorizontalSpacing()
,
unsetHorizontalSpacing()
,
getHorizontalSpacing()
public void unsetHorizontalSpacing()
Horizontal Spacing
' attribute.
isSetHorizontalSpacing()
,
getHorizontalSpacing()
,
setHorizontalSpacing(int)
public boolean isSetHorizontalSpacing()
Horizontal Spacing
' attribute is set.
unsetHorizontalSpacing()
,
getHorizontalSpacing()
,
setHorizontalSpacing(int)
public int getVerticalSpacing()
isSetVerticalSpacing()
,
unsetVerticalSpacing()
,
setVerticalSpacing(int)
,
LayoutPackage.getLegend_VerticalSpacing()
public void setVerticalSpacing(int value)
Vertical Spacing
' attribute.
value
- the new value of the 'Vertical Spacing' attribute.isSetVerticalSpacing()
,
unsetVerticalSpacing()
,
getVerticalSpacing()
public void unsetVerticalSpacing()
Vertical Spacing
' attribute.
isSetVerticalSpacing()
,
getVerticalSpacing()
,
setVerticalSpacing(int)
public boolean isSetVerticalSpacing()
Vertical Spacing
' attribute is set.
unsetVerticalSpacing()
,
getVerticalSpacing()
,
setVerticalSpacing(int)
public ClientArea getClientArea()
setClientArea(ClientArea)
,
LayoutPackage.getLegend_ClientArea()
public void setClientArea(ClientArea value)
Client Area
' containment reference.
value
- the new value of the 'Client Area' containment reference.getClientArea()
public Text getText()
setText(Text)
,
LayoutPackage.getLegend_Text()
public void setText(Text value)
Text
' containment reference.
value
- the new value of the 'Text' containment reference.getText()
public Orientation getOrientation()
"Horizontal"
. The literals are from the enumeration
Orientation
. Gets the orientation to be
used for entries in the legend. This determines the way the entries are arranged in the legend.
The orientation of elements in the legend.
Orientation
,
isSetOrientation()
,
unsetOrientation()
,
setOrientation(Orientation)
,
LayoutPackage.getLegend_Orientation()
public void setOrientation(Orientation value)
Orientation
' attribute.
value
- the new value of the 'Orientation' attribute.Orientation
,
isSetOrientation()
,
unsetOrientation()
,
getOrientation()
public void unsetOrientation()
Orientation
' attribute.
isSetOrientation()
,
getOrientation()
,
setOrientation(Orientation)
public boolean isSetOrientation()
Orientation
' attribute is set.
unsetOrientation()
,
getOrientation()
,
setOrientation(Orientation)
public Direction getDirection()
"Left_Right"
. The literals are from the enumeration
Direction
. Gets the direction to be used
for entries in the legend. This determines the flow of the entries in the legend.
The direction in which the entries are added to the legend.
Direction
,
isSetDirection()
,
unsetDirection()
,
setDirection(Direction)
,
LayoutPackage.getLegend_Direction()
public void setDirection(Direction value)
Direction
' attribute.
value
- the new value of the 'Direction' attribute.Direction
,
isSetDirection()
,
unsetDirection()
,
getDirection()
public void unsetDirection()
Direction
' attribute.
isSetDirection()
,
getDirection()
,
setDirection(Direction)
public boolean isSetDirection()
Direction
' attribute is set.
unsetDirection()
,
getDirection()
,
setDirection(Direction)
public LineAttributes getSeparator()
setSeparator(LineAttributes)
,
LayoutPackage.getLegend_Separator()
public void setSeparator(LineAttributes value)
Separator
' containment reference.
value
- the new value of the 'Separator' containment reference.getSeparator()
public Position getPosition()
"Above"
.
The literals are from the enumeration Position
.
The position of the legend.
Position
,
isSetPosition()
,
unsetPosition()
,
setPosition(Position)
,
LayoutPackage.getLegend_Position()
public void setPosition(Position value)
Position
' attribute.
value
- the new value of the 'Position' attribute.Position
,
isSetPosition()
,
unsetPosition()
,
getPosition()
public void unsetPosition()
Position
' attribute.
isSetPosition()
,
getPosition()
,
setPosition(Position)
public boolean isSetPosition()
Position
' attribute is set.
unsetPosition()
,
getPosition()
,
setPosition(Position)
public LegendItemType getItemType()
"Series"
.
The literals are from the enumeration LegendItemType
.
The form rendering of series should take (by Series or by Categories).
LegendItemType
,
isSetItemType()
,
unsetItemType()
,
setItemType(LegendItemType)
,
LayoutPackage.getLegend_ItemType()
public void setItemType(LegendItemType value)
Item Type
' attribute.
value
- the new value of the 'Item Type' attribute.LegendItemType
,
isSetItemType()
,
unsetItemType()
,
getItemType()
public void unsetItemType()
Item Type
' attribute.
isSetItemType()
,
getItemType()
,
setItemType(LegendItemType)
public boolean isSetItemType()
Item Type
' attribute is set.
unsetItemType()
,
getItemType()
,
setItemType(LegendItemType)
public Label getTitle()
setTitle(Label)
,
LayoutPackage.getLegend_Title()
public void setTitle(Label value)
Title
' containment reference.
value
- the new value of the 'Title' containment reference.getTitle()
public Position getTitlePosition()
"Above"
.
The literals are from the enumeration Position
.
Specifies where the title for the legend should be displayed.
Position
,
isSetTitlePosition()
,
unsetTitlePosition()
,
setTitlePosition(Position)
,
LayoutPackage.getLegend_TitlePosition()
public void setTitlePosition(Position value)
Title Position
' attribute.
value
- the new value of the 'Title Position' attribute.Position
,
isSetTitlePosition()
,
unsetTitlePosition()
,
getTitlePosition()
public void unsetTitlePosition()
Title Position
' attribute.
isSetTitlePosition()
,
getTitlePosition()
,
setTitlePosition(Position)
public boolean isSetTitlePosition()
Title Position
' attribute is set.
unsetTitlePosition()
,
getTitlePosition()
,
setTitlePosition(Position)
public boolean isShowValue()
isSetShowValue()
,
unsetShowValue()
,
setShowValue(boolean)
,
LayoutPackage.getLegend_ShowValue()
public void setShowValue(boolean value)
Show Value
' attribute.
value
- the new value of the 'Show Value' attribute.isSetShowValue()
,
unsetShowValue()
,
isShowValue()
public void unsetShowValue()
Show Value
' attribute.
isSetShowValue()
,
isShowValue()
,
setShowValue(boolean)
public boolean isSetShowValue()
Show Value
' attribute is set.
unsetShowValue()
,
isShowValue()
,
setShowValue(boolean)
public boolean isShowPercent()
isSetShowPercent()
,
unsetShowPercent()
,
setShowPercent(boolean)
,
LayoutPackage.getLegend_ShowPercent()
public void setShowPercent(boolean value)
Show Percent
' attribute.
value
- the new value of the 'Show Percent' attribute.isSetShowPercent()
,
unsetShowPercent()
,
isShowPercent()
public void unsetShowPercent()
Show Percent
' attribute.
isSetShowPercent()
,
isShowPercent()
,
setShowPercent(boolean)
public boolean isSetShowPercent()
Show Percent
' attribute is set.
unsetShowPercent()
,
isShowPercent()
,
setShowPercent(boolean)
public boolean isShowTotal()
isSetShowTotal()
,
unsetShowTotal()
,
setShowTotal(boolean)
,
LayoutPackage.getLegend_ShowTotal()
public void setShowTotal(boolean value)
Show Total
' attribute.
value
- the new value of the 'Show Total' attribute.isSetShowTotal()
,
unsetShowTotal()
,
isShowTotal()
public void unsetShowTotal()
Show Total
' attribute.
isSetShowTotal()
,
isShowTotal()
,
setShowTotal(boolean)
public boolean isSetShowTotal()
Show Total
' attribute is set.
unsetShowTotal()
,
isShowTotal()
,
setShowTotal(boolean)
public double getWrappingSize()
isSetWrappingSize()
,
unsetWrappingSize()
,
setWrappingSize(double)
,
LayoutPackage.getLegend_WrappingSize()
public void setWrappingSize(double value)
Wrapping Size
' attribute.
value
- the new value of the 'Wrapping Size' attribute.isSetWrappingSize()
,
unsetWrappingSize()
,
getWrappingSize()
public void unsetWrappingSize()
Wrapping Size
' attribute.
isSetWrappingSize()
,
getWrappingSize()
,
setWrappingSize(double)
public boolean isSetWrappingSize()
Wrapping Size
' attribute is set.
unsetWrappingSize()
,
getWrappingSize()
,
setWrappingSize(double)
public void updateLayout(Chart cm)
cm
-
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |