|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.ReportItemHandle
org.eclipse.birt.report.model.api.LabelHandle
public class LabelHandle
Represents a label report item. A label shows a static piece of text displayed in the report. The label has the following properties:
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportItemHandle |
---|
DATABINDING_TYPE_DATA, DATABINDING_TYPE_NONE, DATABINDING_TYPE_REPORT_ITEM_REF |
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.ILabelModel |
---|
ACTION_PROP, HELP_TEXT_ID_PROP, HELP_TEXT_PROP, TEXT_ID_PROP, TEXT_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IReportItemModel |
---|
ACL_EXPRESSION_PROP, ALLOW_EXPORT_PROP, BOOKMARK_PROP, BOUND_DATA_COLUMNS_PROP, CASCADE_ACL_PROP, CUBE_PROP, DATA_BINDING_REF_PROP, DATA_SET_PROP, HEIGHT_PROP, MULTI_VIEWS_PROP, ON_CREATE_METHOD, ON_PAGE_BREAK_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, PARAM_BINDINGS_PROP, TOC_PROP, VISIBILITY_PROP, WIDTH_PROP, X_PROP, Y_PROP, Z_INDEX_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel |
---|
STYLE_PROP |
Fields inherited from interface org.eclipse.birt.report.model.api.elements.IReportItemMethodContext |
---|
ON_CREATE_CONTEXT, ON_PREPARE_CONTEXT, ON_RENDER_CONTEXT |
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 | |
---|---|
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. |
Method Summary | |
---|---|
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. |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public 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 elementMethod Detail |
---|
public java.lang.String getText()
public java.lang.String getDisplayText()
public void setText(java.lang.String text) throws SemanticException
text
- the new text for the label
SemanticException
- 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 text
SemanticException
- if the resource key property is locked.public ActionHandle getActionHandle()
null
if
the action has not been set on the label.ActionHandle
public 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.lang.String getHelpText()
public void setHelpText(java.lang.String text) throws SemanticException
text
- the help text
SemanticException
- 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 key
SemanticException
- if the resource key property of the help text is locked.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |