Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.engine.api.script.element
Interface ILabel

All Superinterfaces:
  IDesignElement, IReportElement, IReportItem

    public interface ILabel

extends IReportItem

Represents a the design of a Label in the scripting environment

Method Summary
`IAction` | `getAction()` 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.
`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 interface org.eclipse.birt.report.engine.api.script.element.IReportItem
`addDataBinding, addHideRule, addHighlightRule, getBookmark, getDataBinding, getDataBindings, getHeight, getHideRules, getHighlightRules, getTocExpression, getWidth, getX, getY, removeDataBinding, removeDataBindings, removeHideRule, removeHideRules, removeHighlightRule, removeHighlightRules, setBookmark, setCurrentView, setHeight, setHeight, setTocExpression, setWidth, setWidth, setX, setX, setY, setY`

Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IReportElement
`getComments, getCustomXml, getDisplayName, getDisplayNameKey, getName, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setName`

Methods inherited from interface org.eclipse.birt.report.engine.api.script.element.IDesignElement
`getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, setNamedExpression, setUserProperty, setUserProperty`

Method Detail

### getText

    java.lang.String getText()

  Returns the static text for the label.

  Returns:
    the static text to display

### getDisplayText

    java.lang.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(java.lang.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

    java.lang.String getTextKey()

  Returns the resource key of the static text of the label.

  Returns:
    the resource key of the static text

### setTextKey

    void setTextKey(java.lang.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`

### getHelpText

    java.lang.String getHelpText()

  Returns the help text of this label item.

  Returns:
    the help text

### setHelpText

    void setHelpText(java.lang.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

    java.lang.String getHelpTextKey()

  Returns the help text key of this label item.

  Returns:
    the help text key

### setHelpTextKey

    void setHelpTextKey(java.lang.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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.