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

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

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

A representation of the model object 'Marker Line'. This type defines a single line element. It is intended for use as a marker associated with an Axis. e.g. To denote a Target value

The following features are supported:

See Also:
ComponentPackage.getMarkerLine()

Method Summary
 FormatSpecifier getFormatSpecifier()
          Returns the value of the 'Format Specifier' containment reference.
 Label getLabel()
          Returns the value of the 'Label' containment reference.
 Anchor getLabelAnchor()
          Returns the value of the 'Label Anchor' attribute.
 LineAttributes getLineAttributes()
          Returns the value of the 'Line Attributes' containment reference.
 org.eclipse.emf.common.util.EList getTriggers()
          Returns the value of the 'Triggers' containment reference list.
 DataElement getValue()
          Returns the value of the 'Value' containment reference.
 boolean isSetLabelAnchor()
          Returns whether the value of the 'Label Anchor' attribute is set.
 void setFormatSpecifier(FormatSpecifier value)
          Sets the value of the 'Format Specifier' containment reference.
 void setLabel(Label value)
          Sets the value of the 'Label' containment reference.
 void setLabelAnchor(Anchor value)
          Sets the value of the ' Label Anchor' attribute.
 void setLineAttributes(LineAttributes value)
          Sets the value of the 'Line Attributes' containment reference.
 void setValue(DataElement value)
          Sets the value of the 'Value' containment reference.
 void unsetLabelAnchor()
          Unsets the value of the ' Label Anchor' 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

getLineAttributes

public LineAttributes getLineAttributes()
Returns the value of the 'Line Attributes' containment reference. Specify the line properties.

Returns:
the value of the 'Line Attributes' containment reference.
See Also:
setLineAttributes(LineAttributes), ComponentPackage.getMarkerLine_LineAttributes()

setLineAttributes

public void setLineAttributes(LineAttributes value)
Sets the value of the 'Line Attributes' containment reference.

Parameters:
value - the new value of the 'Line Attributes' containment reference.
See Also:
getLineAttributes()

getValue

public DataElement getValue()
Returns the value of the 'Value' containment reference. Defines where this line is to be positioned w.r.t the axis. (Can be a value on the axis or a category name).

Returns:
the value of the 'Value' containment reference.
See Also:
setValue(DataElement), ComponentPackage.getMarkerLine_Value()

setValue

public void setValue(DataElement value)
Sets the value of the 'Value' containment reference.

Parameters:
value - the new value of the 'Value' containment reference.
See Also:
getValue()

getLabel

public Label getLabel()
Returns the value of the 'Label' containment reference. Specifies the label associated with this line.

Returns:
the value of the 'Label' containment reference.
See Also:
setLabel(Label), ComponentPackage.getMarkerLine_Label()

setLabel

public void setLabel(Label value)
Sets the value of the 'Label' containment reference.

Parameters:
value - the new value of the 'Label' containment reference.
See Also:
getLabel()

getLabelAnchor

public Anchor getLabelAnchor()
Returns the value of the 'Label Anchor' attribute. The default value is "North". The literals are from the enumeration Anchor. Specifies where the label associated with this line is to be positioned with respect to the line itself.

Returns:
the value of the 'Label Anchor' attribute.
See Also:
Anchor, isSetLabelAnchor(), unsetLabelAnchor(), setLabelAnchor(Anchor), ComponentPackage.getMarkerLine_LabelAnchor()

setLabelAnchor

public void setLabelAnchor(Anchor value)
Sets the value of the ' Label Anchor' attribute.

Parameters:
value - the new value of the 'Label Anchor' attribute.
See Also:
Anchor, isSetLabelAnchor(), unsetLabelAnchor(), getLabelAnchor()

unsetLabelAnchor

public void unsetLabelAnchor()
Unsets the value of the ' Label Anchor' attribute.

See Also:
isSetLabelAnchor(), getLabelAnchor(), setLabelAnchor(Anchor)

isSetLabelAnchor

public boolean isSetLabelAnchor()
Returns whether the value of the 'Label Anchor' attribute is set.

Returns:
whether the value of the 'Label Anchor' attribute is set.
See Also:
unsetLabelAnchor(), getLabelAnchor(), setLabelAnchor(Anchor)

getFormatSpecifier

public FormatSpecifier getFormatSpecifier()
Returns the value of the 'Format Specifier' containment reference. Specifies the formatting for marker line labels.

Returns:
the value of the 'Format Specifier' containment reference.
See Also:
setFormatSpecifier(FormatSpecifier), ComponentPackage.getMarkerLine_FormatSpecifier()

setFormatSpecifier

public void setFormatSpecifier(FormatSpecifier value)
Sets the value of the 'Format Specifier' containment reference.

Parameters:
value - the new value of the 'Format Specifier' containment reference.
See Also:
getFormatSpecifier()

getTriggers

public org.eclipse.emf.common.util.EList getTriggers()
Returns the value of the 'Triggers' containment reference list. The list contents are of type Trigger. Holds the triggers for the marker line.

Returns:
the value of the 'Triggers' containment reference list.
See Also:
ComponentPackage.getMarkerLine_Triggers()


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