org.eclipse.birt.chart.model.component
Interface Label

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

public interface Label
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Label'. This type defines a text label. It is not intended as a standalone element but should be associated with a chart element.

The following features are supported:

See Also:
ComponentPackage.getLabel()

Method Summary
 Fill getBackground()
          Returns the value of the 'Background' containment reference.
 Text getCaption()
          Returns the value of the 'Caption' containment reference.
 Insets getInsets()
          Returns the value of the 'Insets' containment reference.
 LineAttributes getOutline()
          Returns the value of the 'Outline' containment reference.
 ColorDefinition getShadowColor()
          Returns the value of the 'Shadow Color' containment reference.
 boolean isSetVisible()
          Returns whether the value of the ' Visible' attribute is set.
 boolean isVisible()
          Returns the value of the 'Visible' attribute.
 void setBackground(Fill value)
          Sets the value of the 'Background' containment reference.
 void setCaption(Text value)
          Sets the value of the 'Caption' containment reference.
 void setInsets(Insets value)
          Sets the value of the 'Insets' containment reference.
 void setOutline(LineAttributes value)
          Sets the value of the 'Outline' containment reference.
 void setShadowColor(ColorDefinition value)
          Sets the value of the 'Shadow Color' containment reference.
 void setVisible(boolean value)
          Sets the value of the 'Visible' attribute.
 void unsetVisible()
          Unsets the value of the 'Visible' attribute.
 
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

getCaption

public Text getCaption()
Returns the value of the 'Caption' containment reference. The string content displayed in the label.

Returns:
the value of the 'Caption' containment reference.
See Also:
setCaption(Text), ComponentPackage.getLabel_Caption()

setCaption

public void setCaption(Text value)
Sets the value of the 'Caption' containment reference.

Parameters:
value - the new value of the 'Caption' containment reference.
See Also:
getCaption()

getBackground

public Fill getBackground()
Returns the value of the 'Background' containment reference. Specifies the background for the label.

Returns:
the value of the 'Background' containment reference.
See Also:
setBackground(Fill), ComponentPackage.getLabel_Background()

setBackground

public void setBackground(Fill value)
Sets the value of the 'Background' containment reference.

Parameters:
value - the new value of the 'Background' containment reference.
See Also:
getBackground()

getOutline

public LineAttributes getOutline()
Returns the value of the 'Outline' containment reference. Defines the outline (border) for the label.

Returns:
the value of the 'Outline' containment reference.
See Also:
setOutline(LineAttributes), ComponentPackage.getLabel_Outline()

setOutline

public void setOutline(LineAttributes value)
Sets the value of the 'Outline' containment reference.

Parameters:
value - the new value of the 'Outline' containment reference.
See Also:
getOutline()

getShadowColor

public ColorDefinition getShadowColor()
Returns the value of the 'Shadow Color' containment reference. Specifies the shadow color for the label.

Returns:
the value of the 'Shadow Color' containment reference.
See Also:
setShadowColor(ColorDefinition), ComponentPackage.getLabel_ShadowColor()

setShadowColor

public void setShadowColor(ColorDefinition value)
Sets the value of the 'Shadow Color' containment reference.

Parameters:
value - the new value of the 'Shadow Color' containment reference.
See Also:
getShadowColor()

getInsets

public Insets getInsets()
Returns the value of the 'Insets' containment reference. Defines the insets for the label.

Returns:
the value of the 'Insets' containment reference.
See Also:
setInsets(Insets), ComponentPackage.getLabel_Insets()

setInsets

public void setInsets(Insets value)
Sets the value of the 'Insets' containment reference.

Parameters:
value - the new value of the 'Insets' containment reference.
See Also:
getInsets()

isVisible

public boolean isVisible()
Returns the value of the 'Visible' attribute. Specifies whether or not the label is visible on the chart.

Returns:
the value of the 'Visible' attribute.
See Also:
isSetVisible(), unsetVisible(), setVisible(boolean), ComponentPackage.getLabel_Visible()

setVisible

public void setVisible(boolean value)
Sets the value of the 'Visible' attribute.

Parameters:
value - the new value of the 'Visible' attribute.
See Also:
isSetVisible(), unsetVisible(), isVisible()

unsetVisible

public void unsetVisible()
Unsets the value of the 'Visible' attribute.

See Also:
isSetVisible(), isVisible(), setVisible(boolean)

isSetVisible

public boolean isSetVisible()
Returns whether the value of the ' Visible' attribute is set.

Returns:
whether the value of the 'Visible' attribute is set.
See Also:
unsetVisible(), isVisible(), setVisible(boolean)


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