Interface ITextItem

All Superinterfaces:
IDesignElement, IReportElement, IReportItem

public interface ITextItem extends IReportItem
Represents a the design of a TextItem in the scripting environment
  • Method Details

    • getContent

      String getContent()
      Gets the text of this text element.
      Returns:
      the text to display with the element, if this property value is not set, return null.
    • getDisplayContent

      String getDisplayContent()
      Returns the localized content for the text. If the localized text for the text resource key is found, it will be returned. Otherwise, the static text will be returned.
      Returns:
      the localized content for the text.
    • setContent

      void setContent(String value) throws SemanticException
      Sets the text for the text element.
      Parameters:
      value - the new content of the text item
      Throws:
      SemanticException - if the property is locked.
    • getContentType

      String getContentType()
      Returns the content type of this text item. The content type will one of the following constants defined in DesignChoiceConstants:
      • TEXT_CONTENT_TYPE_AUTO
      • TEXT_CONTENT_TYPE_PLAIN
      • TEXT_CONTENT_TYPE_HTML
      • TEXT_CONTENT_TYPE_RTF
      Returns:
      the content type. if this property value is not set, return null.
      See Also:
    • setContentType

      void setContentType(String contentType) throws SemanticException
      Sets the content type of this text item. The content type will one of the following constants defined in DesignChoiceConstants:
      • TEXT_CONTENT_TYPE_AUTO
      • TEXT_CONTENT_TYPE_PLAIN
      • TEXT_CONTENT_TYPE_HTML
      • TEXT_CONTENT_TYPE_RTF
      Parameters:
      contentType - the content type of this text item.
      Throws:
      SemanticException - if the value is not a valid choice item.
      See Also:
    • getContentKey

      String getContentKey()
      Gets the resource key of the text for the item.
      Returns:
      the resource key of the text
    • setContentKey

      void setContentKey(String resourceKey) throws SemanticException
      Sets the resource key of the text for the item.
      Parameters:
      resourceKey - the resource key of the text
      Throws:
      SemanticException - if the property is locked.