|
||||||||||
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.TextItemHandle
public class TextItemHandle
Represents a text data item. The text item allows the developer to provide the text as part of the report design. The text can be localized. Text can be in HTML or plain text format.
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.ITextItemModel |
---|
CONTENT_PROP, CONTENT_RESOURCE_KEY_PROP, CONTENT_TYPE_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 | |
---|---|
TextItemHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle for a text item. |
Method Summary | |
---|---|
java.lang.String |
getContent()
Gets the text of this text element. |
java.lang.String |
getContentKey()
Gets the resource key of the text for the item. |
java.lang.String |
getContentType()
Returns the content type of this text item. |
java.lang.String |
getDisplayContent()
Returns the localized content for the text. |
void |
setContent(java.lang.String value)
Sets the text for the text element. |
void |
setContentKey(java.lang.String resourceKey)
Sets the resource key of the text for the item. |
void |
setContentType(java.lang.String contentType)
Sets the content type of this text item. |
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 TextItemHandle(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 getContent()
null
.public java.lang.String getDisplayContent()
public void setContent(java.lang.String value) throws SemanticException
value
- the new content of the text item
SemanticException
- if the property is locked.public java.lang.String getContentType()
DesignChoiceConstants
:
TEXT_CONTENT_TYPE_AUTO
TEXT_CONTENT_TYPE_PLAIN
TEXT_CONTENT_TYPE_HTML
TEXT_CONTENT_TYPE_RTF
null
.DesignChoiceConstants
public void setContentType(java.lang.String contentType) throws SemanticException
DesignChoiceConstants
:
TEXT_CONTENT_TYPE_AUTO
TEXT_CONTENT_TYPE_PLAIN
TEXT_CONTENT_TYPE_HTML
TEXT_CONTENT_TYPE_RTF
contentType
- the content type of this text item.
SemanticException
- if the value is not a valid choice item.DesignChoiceConstants
public java.lang.String getContentKey()
public void setContentKey(java.lang.String resourceKey) throws SemanticException
resourceKey
- the resource key of the text
SemanticException
- if the property is locked.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |