public abstract class LevelHandle extends ReportElementHandle implements org.eclipse.birt.report.model.elements.interfaces.ILevelModel
Level
element
module
ACL_EXPRESSION_PROP, ACTION_PROP, ALIGNMENT_PROP, ATTRIBUTES_PROP, DATA_TYPE_PROP, DATE_TIME_FORMAT_PROP, DATE_TIME_LEVEL_TYPE, DEFAULT_VALUE_PROP, FORMAT_PROP, INTERVAL_BASE_PROP, INTERVAL_PROP, INTERVAL_RANGE_PROP, LEVEL_TYPE_PROP, MEMBER_ACL_EXPRESSION_PROP, STATIC_VALUES_PROP, VALUE_ACCESS_CONTROLS_PROP
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP
Constructor and Description |
---|
LevelHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle for the given design and design element.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<ActionHandle> |
actionsIterator()
Returns the iterator for action defined on this level.
|
java.util.Iterator |
attributesIterator()
Returns the iterator of attributes.
|
ExpressionHandle |
getACLExpression()
Gets the expression handle for the
ACLExpression property. |
ActionHandle |
getActionHandle()
Returns a handle to work with the action property, action is a structure
that defines a hyperlink.
|
java.lang.String |
getAlignment()
Gets the alignment of the level.
|
java.lang.String |
getDataType()
Returns the data type of this level.
|
java.lang.String |
getDateTimeFormat()
Returns the date-time format of this level.
|
java.lang.String |
getDateTimeLevelType()
Returns the date-time type of this level.
|
java.lang.String |
getDefaultValue()
Gets the default value of this level.
|
FormatValueHandle |
getFormat()
Gets the format of the level.
|
java.lang.String |
getInterval()
Returns the interval of this level.
|
java.lang.String |
getIntervalBase()
Return the interval base property value of this level.
|
double |
getIntervalRange()
Returns the interval range of this level.
|
java.lang.String |
getLevelType()
Returns the level type of this level.
|
ExpressionHandle |
getMemberACLExpression()
Gets the expression handle for the ACL expression for any member of this
level.
|
ActionHandle |
setAction(Action action)
Set an action on the level.
|
void |
setAlignment(java.lang.String alignment)
Sets the alignment of the level.
|
void |
setDataType(java.lang.String dataType)
Sets the data type of this level.
|
void |
setDateTimeFormat(java.lang.String dateTimeFormat)
Sets the date-time format of this level.
|
void |
setDateTimeLevelType(java.lang.String dateTimeType)
Sets the date-time type of this level.
|
void |
setDefaultValue(java.lang.String defaultValue)
Sets the default value of this level.
|
void |
setFormat(FormatValue format)
Sets the format of the level.
|
void |
setInterval(java.lang.String interval)
Returns the interval of this level.
|
void |
setIntervalBase(java.lang.String intervalBase)
Sets the base of the interval property of this level.IntervalBase, in
conjunction with Interval and IntervalRange, determines how data is
divided into levels.
|
void |
setIntervalRange(double intervalRange)
Returns the interval range of this level.
|
void |
setIntervalRange(java.lang.String intervalRange)
Sets the interval range of this level.
|
void |
setLevelType(java.lang.String levelType)
Sets the level type.
|
java.util.Iterator |
staticValuesIterator()
Returns the iterator of static values.
|
java.util.Iterator |
valueAccessControlsIterator()
Returns an iterator for the value access controls.
|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask
add, add, addElement, addElement, addListener, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, 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, getEventHandlerClass, getExpressionProperty, getExtends, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isTemplateParameterValue, isValid, localize, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setBooleanProperty, setEncryption, setEventHandlerClass, setExpressionProperty, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, shift, showError, slotsIterator
public LevelHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementpublic java.util.Iterator attributesIterator()
LevelAttributeHandle
for TabularLevel. To OdaLevel, each
member is OdaLevelAttributeHandle
.public java.util.Iterator staticValuesIterator()
RuleHandle
.public void setIntervalBase(java.lang.String intervalBase) throws SemanticException
intervalBase
- interval base property value.SemanticException
- if the property is locked.public java.lang.String getIntervalBase()
public java.lang.String getInterval()
DesignChoiceConstants
and can be one of:
INTERVAL_NONE
INTERVAL_PREFIX
INTERVAL_INTERVAL
public void setInterval(java.lang.String interval) throws SemanticException
DesignChoiceConstants
and can be one of:
INTERVAL_NONE
INTERVAL_PREFIX
INTERVAL_INTERVAL
interval
- the interval value as a stringSemanticException
- if the property is locked or the input value is not one of
the above.public double getIntervalRange()
public void setIntervalRange(double intervalRange) throws SemanticException
intervalRange
- the interval range value as a doubleSemanticException
- if the property is locked.public void setIntervalRange(java.lang.String intervalRange) throws SemanticException
intervalRange
- the interval range value as a string.value is locale
dependent.SemanticException
- if the property is locked.public java.lang.String getLevelType()
LEVEL_TYPE_DYNAMIC
LEVEL_TYPE_MIRRORED
public void setLevelType(java.lang.String levelType) throws SemanticException
DesignChoiceConstants
and can be one of:
LEVEL_TYPE_DYNAMIC
LEVEL_TYPE_MIRRORED
levelType
- SemanticException
public java.lang.String getDataType()
DesignChoiceConstants
,
and they are:
public void setDataType(java.lang.String dataType) throws SemanticException
DesignChoiceConstants
,
and they are:
dataType
- the data type to setSemanticException
- if the dataType is not in the choice list.public java.util.Iterator valueAccessControlsIterator()
ValueAccessControlHandle
.public java.lang.String getDateTimeLevelType()
DesignChoiceConstants
,
and they are:
public void setDateTimeLevelType(java.lang.String dateTimeType) throws SemanticException
DesignChoiceConstants
,
and they are:
dateTimeType
- the date-time type to setSemanticException
- if the dateTimeType is not in the choice list.public java.lang.String getDateTimeFormat()
public void setDateTimeFormat(java.lang.String dateTimeFormat) throws SemanticException
dateTimeFormat
- the date-time format to setSemanticException
- if the date-time-format is lockedpublic void setDefaultValue(java.lang.String defaultValue) throws SemanticException
defaultValue
- the default value.SemanticException
public java.lang.String getDefaultValue()
public ExpressionHandle getACLExpression()
ACLExpression
property.public ExpressionHandle getMemberACLExpression()
public ActionHandle getActionHandle()
null
if the
action has not been set on the level.ActionHandle
public ActionHandle setAction(Action action) throws SemanticException
action
- new action to be set on the level, it represents a bookmark
link, hyper-link, and drill through etc.null
if the
action has not been set on the level.SemanticException
- if member of the action is not valid.public java.util.Iterator<ActionHandle> actionsIterator()
Action
structure list defined on
this levelpublic FormatValueHandle getFormat()
public void setFormat(FormatValue format) throws SemanticException
format
- the format to set.SemanticException
public java.lang.String getAlignment()
DesignChoiceConstants:
- TEXT_ALIGN_LEFT
- TEXT_ALIGN_CENTER
- TEXT_ALIGN_RIGHT
- TEXT_ALIGN_JUSTIFY
public void setAlignment(java.lang.String alignment) throws SemanticException
DesignChoiceConstants:
- TEXT_ALIGN_LEFT
- TEXT_ALIGN_CENTER
- TEXT_ALIGN_RIGHT
- TEXT_ALIGN_JUSTIFY
alignment
- the new alignment to set.SemanticException
Copyright © 2008 Actuate Corp. All rights reserved.