|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ILabel
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.model.api.simpleapi.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.model.api.simpleapi.IReportElement |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getName, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setName |
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement |
---|
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, setNamedExpression, setUserProperty, setUserProperty |
Method Detail |
---|
java.lang.String getText()
java.lang.String getDisplayText()
void setText(java.lang.String text) throws SemanticException
text
- the new text for the label
SemanticException
- if the property is locked.java.lang.String getTextKey()
void setTextKey(java.lang.String resourceKey) throws SemanticException
resourceKey
- the resource key of the static text
SemanticException
- if the resource key property is locked.IAction getAction()
null
if
the action has not been set on the label.ActionHandle
java.lang.String getHelpText()
void setHelpText(java.lang.String text) throws SemanticException
text
- the help text
SemanticException
- if the resource key property is locked.java.lang.String getHelpTextKey()
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 |