org.eclipse.birt.chart.model.attribute
Interface URLValue

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

public interface URLValue
extends ActionValue

A representation of the model object 'URL Value'. This type defines the value for a 'URL_Redirect' action.

The following features are supported:

See Also:
AttributePackage.getURLValue()

Method Summary
 URLValue copyInstance()
          A convenient method to get an instance copy.
 java.lang.String getBaseParameterName()
          Returns the value of the 'Base Parameter Name' attribute.
 java.lang.String getBaseUrl()
          Returns the value of the 'Base Url' attribute.
 Label getLabel()
          Returns the value of the 'Label' containment reference.
 java.lang.String getSeriesParameterName()
          Returns the value of the 'Series Parameter Name' attribute.
 java.lang.String getTarget()
          Returns the value of the 'Target' attribute.
 java.lang.String getTooltip()
          Returns the value of the 'Tooltip' attribute.
 java.lang.String getValueParameterName()
          Returns the value of the 'Value Parameter Name' attribute.
 void setBaseParameterName(java.lang.String value)
          Sets the value of the 'Base Parameter Name' attribute.
 void setBaseUrl(java.lang.String value)
          Sets the value of the 'Base Url' attribute.
 void setLabel(Label value)
          Sets the value of the 'Label' containment reference.
 void setSeriesParameterName(java.lang.String value)
          Sets the value of the 'Series Parameter Name' attribute.
 void setTarget(java.lang.String value)
          Sets the value of the 'Target' attribute.
 void setTooltip(java.lang.String value)
          Sets the value of the 'Tooltip' attribute.
 void setValueParameterName(java.lang.String value)
          Sets the value of the 'Value Parameter Name' 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

getBaseUrl

java.lang.String getBaseUrl()
Returns the value of the 'Base Url' attribute. Holds the base URL. This should include any static parameters like login information etc. and should NOT be encoded.

Returns:
the value of the 'Base Url' attribute.
See Also:
setBaseUrl(String), AttributePackage.getURLValue_BaseUrl()

setBaseUrl

void setBaseUrl(java.lang.String value)
Sets the value of the 'Base Url' attribute.

Parameters:
value - the new value of the 'Base Url' attribute.
See Also:
getBaseUrl()

getTarget

java.lang.String getTarget()
Returns the value of the 'Target' attribute. This element defines the target value to be used for the browser.

Returns:
the value of the 'Target' attribute.
See Also:
setTarget(String), AttributePackage.getURLValue_Target()

setTarget

void setTarget(java.lang.String value)
Sets the value of the 'Target' attribute.

Parameters:
value - the new value of the 'Target' attribute.
See Also:
getTarget()

getBaseParameterName

java.lang.String getBaseParameterName()
Returns the value of the 'Base Parameter Name' attribute. This element specifies the name to be used for the parameter whose value will be picked up from the base axis (if any).

Returns:
the value of the 'Base Parameter Name' attribute.
See Also:
setBaseParameterName(String), AttributePackage.getURLValue_BaseParameterName()

setBaseParameterName

void setBaseParameterName(java.lang.String value)
Sets the value of the 'Base Parameter Name' attribute.

Parameters:
value - the new value of the 'Base Parameter Name' attribute.
See Also:
getBaseParameterName()

getValueParameterName

java.lang.String getValueParameterName()
Returns the value of the 'Value Parameter Name' attribute. This element specifies the name to be used for the parameter whose value will be picked up from the current data value.

Returns:
the value of the 'Value Parameter Name' attribute.
See Also:
setValueParameterName(String), AttributePackage.getURLValue_ValueParameterName()

setValueParameterName

void setValueParameterName(java.lang.String value)
Sets the value of the 'Value Parameter Name' attribute.

Parameters:
value - the new value of the 'Value Parameter Name' attribute.
See Also:
getValueParameterName()

getSeriesParameterName

java.lang.String getSeriesParameterName()
Returns the value of the 'Series Parameter Name' attribute. This element specifies the name to be used for the parameter whose value will be picked up from the current series.

Returns:
the value of the 'Series Parameter Name' attribute.
See Also:
setSeriesParameterName(String), AttributePackage.getURLValue_SeriesParameterName()

setSeriesParameterName

void setSeriesParameterName(java.lang.String value)
Sets the value of the 'Series Parameter Name' attribute.

Parameters:
value - the new value of the 'Series Parameter Name' attribute.
See Also:
getSeriesParameterName()

getTooltip

java.lang.String getTooltip()
Returns the value of the 'Tooltip' attribute. The element defines a tooltip string to be displayed when mouse is over.

Returns:
the value of the 'Tooltip' attribute.
See Also:
setTooltip(String), AttributePackage.getURLValue_Tooltip()

setTooltip

void setTooltip(java.lang.String value)
Sets the value of the 'Tooltip' attribute.

Parameters:
value - the new value of the 'Tooltip' attribute.
See Also:
getTooltip()

getLabel

Label getLabel()
Returns the value of the 'Label' containment reference.

If the meaning of the 'Label' containment reference isn't clear, there really should be more of a description here...

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

setLabel

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()

copyInstance

URLValue copyInstance()
A convenient method to get an instance copy. This is much faster than the ECoreUtil.copy().

Specified by:
copyInstance in interface ActionValue


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