All Superinterfaces:
IDesignElement, IReportElement, IReportItem

public interface ILabel extends IReportItem
Represents a the design of a Label in the scripting environment
  • Method Details

    • getText

      String getText()
      Returns the static text for the label.
      Returns:
      the static text to display
    • getDisplayText

      String getDisplayText()
      Returns the localized text for the label. 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 text for the label
    • setText

      void setText(String text) throws ScriptException
      Sets the text of the label. Sets the static text itself. If the label is to be externalized, then set the text ID separately.
      Parameters:
      text - the new text for the label
      Throws:
      ScriptException - if the property is locked.
    • getTextKey

      String getTextKey()
      Returns the resource key of the static text of the label.
      Returns:
      the resource key of the static text
    • setTextKey

      void setTextKey(String resourceKey) throws ScriptException
      Sets the resource key of the static text of the label.
      Parameters:
      resourceKey - the resource key of the static text
      Throws:
      ScriptException - if the resource key property is locked.
    • getAction

      IAction getAction()
      Returns a handle to work with the action property, action is a structure that defines a hyperlink.
      Returns:
      a handle to the action property, return null if the action has not been set on the label.
      See Also:
      • ActionHandle
    • addAction

      void addAction(IAction action)
      Adds the action structure to this Label item.
      Parameters:
      action - the action stucture to be added.
    • getHelpText

      String getHelpText()
      Returns the help text of this label item.
      Returns:
      the help text
    • setHelpText

      void setHelpText(String text) throws ScriptException
      Sets the help text of this label item.
      Parameters:
      text - the help text
      Throws:
      ScriptException - if the resource key property is locked.
    • getHelpTextKey

      String getHelpTextKey()
      Returns the help text key of this label item.
      Returns:
      the help text key
    • setHelpTextKey

      void setHelpTextKey(String resourceKey) throws ScriptException
      Sets the help text key of this label item.
      Parameters:
      resourceKey - the help text key
      Throws:
      ScriptException - if the resource key property of the help text is locked.