public class LabelHandle extends ReportItemHandle implements org.eclipse.birt.report.model.elements.interfaces.ILabelModel
DATABINDING_TYPE_DATA, DATABINDING_TYPE_NONE, DATABINDING_TYPE_REPORT_ITEM_REFelementmoduleACTION_PROP, HELP_TEXT_ID_PROP, HELP_TEXT_PROP, TEXT_ID_PROP, TEXT_PROPACL_EXPRESSION_PROP, ALLOW_EXPORT_PROP, ALTTEXT_KEY_PROP, ALTTEXT_PROP, BOOKMARK_DISPLAY_NAME_PROP, BOOKMARK_PROP, BOUND_DATA_COLUMNS_PROP, CASCADE_ACL_PROP, CUBE_PROP, DATA_BINDING_REF_PROP, DATA_SET_PROP, HEIGHT_PROP, LANGUAGE_PROP, MULTI_VIEWS_PROP, ON_CREATE_METHOD, ON_PAGE_BREAK_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, ORDER_PROP, PARAM_BINDINGS_PROP, PUSH_DOWN_PROP, TAG_TYPE_PROP, THEME_PROP, TOC_PROP, URL_PROP, VISIBILITY_PROP, WIDTH_PROP, X_PROP, Y_PROP, Z_INDEX_PROPON_CREATE_CONTEXT, ON_PREPARE_CONTEXT, ON_RENDER_CONTEXTCOMMENTS_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| 构造器和说明 |
|---|
LabelHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a label handle with the given design and the element.
|
| 限定符和类型 | 方法和说明 |
|---|---|
java.util.Iterator<ActionHandle> |
actionsIterator()
Returns the iterator for action defined on this label item.
|
ActionHandle |
getActionHandle()
Returns a handle to work with the action property, action is a structure
that defines a hyperlink.
|
java.lang.String |
getDisplayText()
Returns the localized text for the label.
|
java.lang.String |
getHelpText()
Returns the help text of this label item.
|
java.lang.String |
getHelpTextKey()
Returns the help text key of this label item.
|
java.lang.String |
getText()
Returns the static text for the label.
|
java.lang.String |
getTextKey()
Returns the resource key of the static text of the label.
|
ActionHandle |
setAction(Action action)
Set an action on the image.
|
void |
setHelpText(java.lang.String text)
Sets the help text of this label item.
|
void |
setHelpTextKey(java.lang.String resourceKey)
Sets the help text key of this label item.
|
void |
setText(java.lang.String text)
Sets the text of the label.
|
void |
setTextKey(java.lang.String resourceKey)
Sets the resource key of the static text of the label.
|
addColumnBinding, addTOC, addTOC, addView, allowExport, canAddView, canCascadeACL, cascadeACL, columnBindingsIterator, dropView, findColumnBinding, getACLExpression, getAltTextExpression, getAltTextKey, getAvailableBindings, getAvailableCubeBindingReferenceList, getAvailableDataBindingReferenceList, getAvailableDataBindingReferenceList, getAvailableDataSetBindingReferenceList, getBookmark, getBookmarkDisplayName, getColumnBindings, getCube, getCurrentView, getDataBindingReference, getDataBindingReferenceName, getDataBindingType, getDataSet, getHeight, getLanguage, getMethods, getNamedCubeBindingReferenceList, getNamedDataBindingReferenceList, getNamedDataSetBindingReferenceList, getOnCreate, getOnPageBreak, getOnPrepare, getOnRender, getOrder, getProperty, getTagType, getTheme, getTOC, getTocExpression, getURL, getViewHost, getViews, getWidth, getX, getY, getZIndex, paramBindingsIterator, pushDown, removedColumnBinding, removedColumnBindings, removedUnusedColumnBindings, setACLExpression, setAllowExport, setAltTextExpression, setAltTextKey, setBookmark, setBookmarkDisplayName, setCascadeACL, setCube, setCurrentView, setDataBindingReference, setDataSet, setHeight, setHeight, setLanguage, setOnCreate, setOnPageBreak, setOnPrepare, setOnRender, setOrder, setPushDown, setTagType, setTheme, setThemeName, setTocExpression, setURL, setWidth, setWidth, setX, setX, setY, setY, setZIndex, visibilityRulesIteratorgetComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMaskadd, 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, 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, slotsIteratorpublic LabelHandle(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.lang.String getText()
public java.lang.String getDisplayText()
public void setText(java.lang.String text)
throws SemanticException
text - the new text for the labelSemanticException - if the property is locked.public java.lang.String getTextKey()
public void setTextKey(java.lang.String resourceKey)
throws SemanticException
resourceKey - the resource key of the static textSemanticException - if the resource key property is locked.public ActionHandle getActionHandle()
null if the
action has not been set on the label.ActionHandlepublic ActionHandle setAction(Action action) throws SemanticException
action - new action to be set on the image, it represents a bookmark
link, hyperlink, and drill through etc.null if the
action has not been set on the image.SemanticException - if member of the action is not valid.public java.util.Iterator<ActionHandle> actionsIterator()
Action structure list defined on
this label itempublic java.lang.String getHelpText()
public void setHelpText(java.lang.String text)
throws SemanticException
text - the help textSemanticException - if the resource key property is locked.public java.lang.String getHelpTextKey()
public void setHelpTextKey(java.lang.String resourceKey)
throws SemanticException
resourceKey - the help text keySemanticException - if the resource key property of the help text is locked.Copyright © 2008 Actuate Corp. All rights reserved.