org.eclipse.birt.report.model.api
Class VariableElementHandle

java.lang.Object
  extended by org.eclipse.birt.report.model.api.DesignElementHandle
      extended by org.eclipse.birt.report.model.api.ContentElementHandle
          extended by org.eclipse.birt.report.model.api.VariableElementHandle
All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IVariableElementModel

public class VariableElementHandle
extends ContentElementHandle
implements org.eclipse.birt.report.model.elements.interfaces.IVariableElementModel

Represents a variable.


Field Summary
 
Fields inherited from class org.eclipse.birt.report.model.api.ContentElementHandle
element
 
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
module
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IVariableElementModel
VALUE_PROP, VARIABLE_NAME_PROP
 
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP
 
Constructor Summary
VariableElementHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
          Constructs a variable handle with the given design and the element.
 
Method Summary
 java.lang.String getValue()
          Returns the value of the variable.
 java.lang.String getVariableName()
          Returns the name of the variable.
 void setValue(java.lang.String value)
          Sets the value of the variable.
 void setVariableName(java.lang.String name)
          Sets the name of the variable.
 
Methods inherited from class org.eclipse.birt.report.model.api.ContentElementHandle
addListener, addUserPropertyDefn, canTransformToTemplate, clientsIterator, createTemplateElement, derivedIterator, getElement, getEventHandlerClass, getExtends, getName, getPrivateStyle, getQualifiedName, getUserProperties, getUserPropertyDefnHandle, isTemplateParameterValue, localize, removeListener, revertToReportItem, revertToTemplate, setEventHandlerClass, setExtends, setExtendsName, setName, setStyle, setStyleName
 
Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
add, add, addElement, addElement, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, clearAllProperties, clearContents, clearProperty, copy, copyPropertyTo, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getNumberProperty, getProperty, getPropertyBinding, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isValid, move, move, moveTo, moveTo, moveTo, moveTo, paste, paste, paste, paste, semanticCheck, setEncryption, setExtendsElement, setFloatProperty, setIntProperty, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyleElement, setValid, shift, showError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VariableElementHandle

public VariableElementHandle(org.eclipse.birt.report.model.core.Module module,
                             org.eclipse.birt.report.model.core.DesignElement element)
Constructs a variable handle with the given design and the element. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.

Parameters:
module - the module
element - the model representation of the element
Method Detail

getVariableName

public java.lang.String getVariableName()
Returns the name of the variable.

Returns:
the variable name

setVariableName

public void setVariableName(java.lang.String name)
                     throws SemanticException
Sets the name of the variable.

Parameters:
name - the name to set
Throws:
SemanticException
See Also:
getVariableName()

getValue

public java.lang.String getValue()
Returns the value of the variable.

Returns:
the variable value

setValue

public void setValue(java.lang.String value)
              throws SemanticException
Sets the value of the variable.

Parameters:
value - the value to set
Throws:
SemanticException


Copyright © 2008 Actuate Corp. All rights reserved.