org.eclipse.birt.chart.model.layout
Interface Legend

All Superinterfaces:
Block, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
LegendImpl

public interface Legend
extends Block

A representation of the model object 'Legend'. The Legend in a chart.

The following features are supported:

See Also:
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.
 double getMaxPercent()
          Returns the value of the 'Max Percent' 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 isSetMaxPercent()
          Returns whether the value of the 'Max Percent' 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 setMaxPercent(double value)
          Sets the value of the 'Max Percent' 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 unsetMaxPercent()
          Unsets the value of the 'Max Percent' 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

getHorizontalSpacing

int getHorizontalSpacing()
Returns the value of the 'Horizontal Spacing' attribute. Gets the horizontal spacing between entries in the legend. The horizontal spacing between elements in the legend.

Returns:
the value of the 'Horizontal Spacing' attribute.
See Also:
isSetHorizontalSpacing(), unsetHorizontalSpacing(), setHorizontalSpacing(int), LayoutPackage.getLegend_HorizontalSpacing()

setHorizontalSpacing

void setHorizontalSpacing(int value)
Sets the value of the 'Horizontal Spacing' attribute.

Parameters:
value - the new value of the 'Horizontal Spacing' attribute.
See Also:
isSetHorizontalSpacing(), unsetHorizontalSpacing(), getHorizontalSpacing()

unsetHorizontalSpacing

void unsetHorizontalSpacing()
Unsets the value of the 'Horizontal Spacing' attribute.

See Also:
isSetHorizontalSpacing(), getHorizontalSpacing(), setHorizontalSpacing(int)

isSetHorizontalSpacing

boolean isSetHorizontalSpacing()
Returns whether the value of the 'Horizontal Spacing' attribute is set.

Returns:
whether the value of the 'Horizontal Spacing' attribute is set.
See Also:
unsetHorizontalSpacing(), getHorizontalSpacing(), setHorizontalSpacing(int)

getVerticalSpacing

int getVerticalSpacing()
Returns the value of the 'Vertical Spacing' attribute. Gets the vertical spacing between entries in the legend. The vertical spacing between elements in the legend.

Returns:
the value of the 'Vertical Spacing' attribute.
See Also:
isSetVerticalSpacing(), unsetVerticalSpacing(), setVerticalSpacing(int), LayoutPackage.getLegend_VerticalSpacing()

setVerticalSpacing

void setVerticalSpacing(int value)
Sets the value of the ' Vertical Spacing' attribute.

Parameters:
value - the new value of the 'Vertical Spacing' attribute.
See Also:
isSetVerticalSpacing(), unsetVerticalSpacing(), getVerticalSpacing()

unsetVerticalSpacing

void unsetVerticalSpacing()
Unsets the value of the ' Vertical Spacing' attribute.

See Also:
isSetVerticalSpacing(), getVerticalSpacing(), setVerticalSpacing(int)

isSetVerticalSpacing

boolean isSetVerticalSpacing()
Returns whether the value of the 'Vertical Spacing' attribute is set.

Returns:
whether the value of the 'Vertical Spacing' attribute is set.
See Also:
unsetVerticalSpacing(), getVerticalSpacing(), setVerticalSpacing(int)

getClientArea

ClientArea getClientArea()
Returns the value of the 'Client Area' containment reference. Gets the client area of the legend where the legend entries will be displayed. The area of the legend block within which the legend items are displayed.

Returns:
the value of the 'Client Area' containment reference.
See Also:
setClientArea(ClientArea), LayoutPackage.getLegend_ClientArea()

setClientArea

void setClientArea(ClientArea value)
Sets the value of the 'Client Area' containment reference.

Parameters:
value - the new value of the 'Client Area' containment reference.
See Also:
getClientArea()

getText

Text getText()
Returns the value of the 'Text' containment reference. Gets the text instance that holds the formatting information for entries in the legend. The actual text content of the block.

Returns:
the value of the 'Text' containment reference.
See Also:
setText(Text), LayoutPackage.getLegend_Text()

setText

void setText(Text value)
Sets the value of the 'Text' containment reference.

Parameters:
value - the new value of the 'Text' containment reference.
See Also:
getText()

getOrientation

Orientation getOrientation()
Returns the value of the 'Orientation' attribute. The default value is "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.

Returns:
the value of the 'Orientation' attribute.
See Also:
Orientation, isSetOrientation(), unsetOrientation(), setOrientation(Orientation), LayoutPackage.getLegend_Orientation()

setOrientation

void setOrientation(Orientation value)
Sets the value of the 'Orientation' attribute.

Parameters:
value - the new value of the 'Orientation' attribute.
See Also:
Orientation, isSetOrientation(), unsetOrientation(), getOrientation()

unsetOrientation

void unsetOrientation()
Unsets the value of the 'Orientation' attribute.

See Also:
isSetOrientation(), getOrientation(), setOrientation(Orientation)

isSetOrientation

boolean isSetOrientation()
Returns whether the value of the ' Orientation' attribute is set.

Returns:
whether the value of the 'Orientation' attribute is set.
See Also:
unsetOrientation(), getOrientation(), setOrientation(Orientation)

getDirection

Direction getDirection()
Returns the value of the 'Direction' attribute. The default value is "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.

Returns:
the value of the 'Direction' attribute.
See Also:
Direction, isSetDirection(), unsetDirection(), setDirection(Direction), LayoutPackage.getLegend_Direction()

setDirection

void setDirection(Direction value)
Sets the value of the 'Direction' attribute.

Parameters:
value - the new value of the 'Direction' attribute.
See Also:
Direction, isSetDirection(), unsetDirection(), getDirection()

unsetDirection

void unsetDirection()
Unsets the value of the 'Direction' attribute.

See Also:
isSetDirection(), getDirection(), setDirection(Direction)

isSetDirection

boolean isSetDirection()
Returns whether the value of the ' Direction' attribute is set.

Returns:
whether the value of the 'Direction' attribute is set.
See Also:
unsetDirection(), getDirection(), setDirection(Direction)

getSeparator

LineAttributes getSeparator()
Returns the value of the 'Separator' containment reference. Gets the separator attributes. The separator is used in the legend to separate entries that are produced by different series keys. The line attributes to be used for the line separating groups of entries in the legend.

Returns:
the value of the 'Separator' containment reference.
See Also:
setSeparator(LineAttributes), LayoutPackage.getLegend_Separator()

setSeparator

void setSeparator(LineAttributes value)
Sets the value of the 'Separator' containment reference.

Parameters:
value - the new value of the 'Separator' containment reference.
See Also:
getSeparator()

getPosition

Position getPosition()
Returns the value of the 'Position' attribute. The default value is "Above". The literals are from the enumeration Position. The position of the legend.

Returns:
the value of the 'Position' attribute.
See Also:
Position, isSetPosition(), unsetPosition(), setPosition(Position), LayoutPackage.getLegend_Position()

setPosition

void setPosition(Position value)
Sets the value of the 'Position' attribute.

Parameters:
value - the new value of the 'Position' attribute.
See Also:
Position, isSetPosition(), unsetPosition(), getPosition()

unsetPosition

void unsetPosition()
Unsets the value of the 'Position' attribute.

See Also:
isSetPosition(), getPosition(), setPosition(Position)

isSetPosition

boolean isSetPosition()
Returns whether the value of the ' Position' attribute is set.

Returns:
whether the value of the 'Position' attribute is set.
See Also:
unsetPosition(), getPosition(), setPosition(Position)

getItemType

LegendItemType getItemType()
Returns the value of the 'Item Type' attribute. The default value is "Series". The literals are from the enumeration LegendItemType. The form rendering of series should take (by Series or by Categories).

Returns:
the value of the 'Item Type' attribute.
See Also:
LegendItemType, isSetItemType(), unsetItemType(), setItemType(LegendItemType), LayoutPackage.getLegend_ItemType()

setItemType

void setItemType(LegendItemType value)
Sets the value of the 'Item Type' attribute.

Parameters:
value - the new value of the 'Item Type' attribute.
See Also:
LegendItemType, isSetItemType(), unsetItemType(), getItemType()

unsetItemType

void unsetItemType()
Unsets the value of the 'Item Type' attribute.

See Also:
isSetItemType(), getItemType(), setItemType(LegendItemType)

isSetItemType

boolean isSetItemType()
Returns whether the value of the ' Item Type' attribute is set.

Returns:
whether the value of the 'Item Type' attribute is set.
See Also:
unsetItemType(), getItemType(), setItemType(LegendItemType)

getTitle

Label getTitle()
Returns the value of the 'Title' containment reference. A label instance to hold attributes for legend title.

Returns:
the value of the 'Title' containment reference.
See Also:
setTitle(Label), LayoutPackage.getLegend_Title()

setTitle

void setTitle(Label value)
Sets the value of the 'Title' containment reference.

Parameters:
value - the new value of the 'Title' containment reference.
See Also:
getTitle()

getTitlePosition

Position getTitlePosition()
Returns the value of the 'Title Position' attribute. The default value is "Above". The literals are from the enumeration Position. Specifies where the title for the legend should be displayed.

Returns:
the value of the 'Title Position' attribute.
See Also:
Position, isSetTitlePosition(), unsetTitlePosition(), setTitlePosition(Position), LayoutPackage.getLegend_TitlePosition()

setTitlePosition

void setTitlePosition(Position value)
Sets the value of the 'Title Position' attribute.

Parameters:
value - the new value of the 'Title Position' attribute.
See Also:
Position, isSetTitlePosition(), unsetTitlePosition(), getTitlePosition()

unsetTitlePosition

void unsetTitlePosition()
Unsets the value of the 'Title Position' attribute.

See Also:
isSetTitlePosition(), getTitlePosition(), setTitlePosition(Position)

isSetTitlePosition

boolean isSetTitlePosition()
Returns whether the value of the 'Title Position' attribute is set.

Returns:
whether the value of the 'Title Position' attribute is set.
See Also:
unsetTitlePosition(), getTitlePosition(), setTitlePosition(Position)

isShowValue

boolean isShowValue()
Returns the value of the 'Show Value' attribute. Specifies if show legend item value.

Returns:
the value of the 'Show Value' attribute.
See Also:
isSetShowValue(), unsetShowValue(), setShowValue(boolean), LayoutPackage.getLegend_ShowValue()

setShowValue

void setShowValue(boolean value)
Sets the value of the 'Show Value' attribute.

Parameters:
value - the new value of the 'Show Value' attribute.
See Also:
isSetShowValue(), unsetShowValue(), isShowValue()

unsetShowValue

void unsetShowValue()
Unsets the value of the 'Show Value' attribute.

See Also:
isSetShowValue(), isShowValue(), setShowValue(boolean)

isSetShowValue

boolean isSetShowValue()
Returns whether the value of the 'Show Value' attribute is set.

Returns:
whether the value of the 'Show Value' attribute is set.
See Also:
unsetShowValue(), isShowValue(), setShowValue(boolean)

isShowPercent

boolean isShowPercent()
Returns the value of the 'Show Percent' attribute. Specifies if show legend item value as percentile.

Returns:
the value of the 'Show Percent' attribute.
See Also:
isSetShowPercent(), unsetShowPercent(), setShowPercent(boolean), LayoutPackage.getLegend_ShowPercent()

setShowPercent

void setShowPercent(boolean value)
Sets the value of the 'Show Percent' attribute.

Parameters:
value - the new value of the 'Show Percent' attribute.
See Also:
isSetShowPercent(), unsetShowPercent(), isShowPercent()

unsetShowPercent

void unsetShowPercent()
Unsets the value of the 'Show Percent' attribute.

See Also:
isSetShowPercent(), isShowPercent(), setShowPercent(boolean)

isSetShowPercent

boolean isSetShowPercent()
Returns whether the value of the 'Show Percent' attribute is set.

Returns:
whether the value of the 'Show Percent' attribute is set.
See Also:
unsetShowPercent(), isShowPercent(), setShowPercent(boolean)

isShowTotal

boolean isShowTotal()
Returns the value of the 'Show Total' attribute. Specifies if show legend item value total.

Returns:
the value of the 'Show Total' attribute.
See Also:
isSetShowTotal(), unsetShowTotal(), setShowTotal(boolean), LayoutPackage.getLegend_ShowTotal()

setShowTotal

void setShowTotal(boolean value)
Sets the value of the 'Show Total' attribute.

Parameters:
value - the new value of the 'Show Total' attribute.
See Also:
isSetShowTotal(), unsetShowTotal(), isShowTotal()

unsetShowTotal

void unsetShowTotal()
Unsets the value of the 'Show Total' attribute.

See Also:
isSetShowTotal(), isShowTotal(), setShowTotal(boolean)

isSetShowTotal

boolean isSetShowTotal()
Returns whether the value of the 'Show Total' attribute is set.

Returns:
whether the value of the 'Show Total' attribute is set.
See Also:
unsetShowTotal(), isShowTotal(), setShowTotal(boolean)

getWrappingSize

double getWrappingSize()
Returns the value of the 'Wrapping Size' attribute. Specifies the maximum string size for each legend item. If the string size is greater than this, it will be wrapped. Zero means no wrap.

Returns:
the value of the 'Wrapping Size' attribute.
See Also:
isSetWrappingSize(), unsetWrappingSize(), setWrappingSize(double), LayoutPackage.getLegend_WrappingSize()

setWrappingSize

void setWrappingSize(double value)
Sets the value of the 'Wrapping Size' attribute.

Parameters:
value - the new value of the 'Wrapping Size' attribute.
See Also:
isSetWrappingSize(), unsetWrappingSize(), getWrappingSize()

unsetWrappingSize

void unsetWrappingSize()
Unsets the value of the 'Wrapping Size' attribute.

See Also:
isSetWrappingSize(), getWrappingSize(), setWrappingSize(double)

isSetWrappingSize

boolean isSetWrappingSize()
Returns whether the value of the 'Wrapping Size' attribute is set.

Returns:
whether the value of the 'Wrapping Size' attribute is set.
See Also:
unsetWrappingSize(), getWrappingSize(), setWrappingSize(double)

getMaxPercent

double getMaxPercent()
Returns the value of the 'Max Percent' attribute. The default value is "0.33333333". The maximal percent of space which the legend can take from the chart block.

Returns:
the value of the 'Max Percent' attribute.
See Also:
isSetMaxPercent(), unsetMaxPercent(), setMaxPercent(double), LayoutPackage.getLegend_MaxPercent()

setMaxPercent

void setMaxPercent(double value)
Sets the value of the 'Max Percent' attribute.

Parameters:
value - the new value of the 'Max Percent' attribute.
See Also:
isSetMaxPercent(), unsetMaxPercent(), getMaxPercent()

unsetMaxPercent

void unsetMaxPercent()
Unsets the value of the 'Max Percent' attribute.

See Also:
isSetMaxPercent(), getMaxPercent(), setMaxPercent(double)

isSetMaxPercent

boolean isSetMaxPercent()
Returns whether the value of the 'Max Percent' attribute is set.

Returns:
whether the value of the 'Max Percent' attribute is set.
See Also:
unsetMaxPercent(), getMaxPercent(), setMaxPercent(double)

updateLayout

void updateLayout(Chart cm)
Update the legend's block relationship in the hierarchy w.r.t. the chart model

Parameters:
cm -


Copyright © 2005-2008 Actuate Corp. All rights reserved.