|
SilverStream Application Server 3.5 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sssw.shr.page.AgpTag | +--com.sssw.shr.page.AgpControlBase | +--com.sssw.shr.page.AgpLabel
A control representing text. The text can be programmatically changed or bound to an expression. It cannot be edited by the user.
Field Summary | |
static int |
LABELTYPE_EVENT_LINK
|
static int |
LABELTYPE_EXPRESSION_LINK
|
static int |
LABELTYPE_LABEL
|
Fields inherited from class com.sssw.shr.page.AgpTag |
UNIT_PERCENT,
UNIT_PIXEL |
Constructor Summary | |
AgpLabel()
|
Method Summary | |
String |
getLinkTarget()
Returns the string that is used as a destination if this label is an Expression Link. |
boolean |
getRawHTMLMode()
Returns whether the control is in raw HTML mode. |
String |
getTargetFrame()
Returns the name of the frame that will be used to display the destination page if this label is an Expression Link. |
String |
getText()
Returns the text displayed in the control. |
int |
getType()
Returns an int representing the type of control. |
void |
setLinkTarget(String target)
Specify the destination to be used if this label is an Expression Link. |
void |
setRawHTMLMode(boolean israw)
Sets whether the control is in raw HTML mode. |
void |
setTargetFrame(String targetFrame)
Specify the frame that will be used to display the destination page if this label is an Expression Link. |
void |
setText(String text)
Sets the text to display in the control. |
void |
setType(int type)
Sets the type of label. |
Methods inherited from class com.sssw.shr.page.AgpControlBase |
getName |
Methods inherited from class com.sssw.shr.page.AgpTag |
getBoolProperty,
getEnableHTMLGeneration,
getIntArrayProperty,
getIntProperty,
getIntPropertyUnit,
getProperty,
getStringArrayProperty,
invalidateHTML,
removeProperty,
setEnableHTMLGeneration,
setIntProperty,
setProperty |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Methods implemented from interface com.sssw.shr.page.AgiJavaScriptEnhanced |
generateFunction,
generateRepaintScript,
generateScriptInitializers,
getFunctionNameForMethod,
getFunctionNames,
getMethodNames,
getScriptObjectName,
isHTMLRepaintPending,
isJavaScriptRepaintPending |
Methods implemented from interface com.sssw.shr.page.AgiPageControl |
generateHTML,
getPrefix,
notifyPageLoaded,
notifyPageRequestBegin,
notifyPageRequestEnd,
notifyPostValue,
notifyPostValues |
Methods implemented from interface java.io.Externalizable |
readExternal,
writeExternal |
Field Detail |
public static final int LABELTYPE_LABEL
public static final int LABELTYPE_EXPRESSION_LINK
public static final int LABELTYPE_EVENT_LINK
Constructor Detail |
public AgpLabel()
Method Detail |
public String getText()
setText()
method.String s = Label1.getText();
AgpLabel.setText(String text)
public void setText(String text)
text
- a string to display.Label1.setText("Hello world!");
If the label's text was set at design time using the Expression field of the
Property Inspector, the design-time setting will always override the setText()
method.
AgpLabel.getText()
public int getType()
LABELTYPE_LABEL
- LabelLABELTYPE_EXPRESSION_LINK
- ExpressionLABELTYPE_EVENT_LINK
- Event linkString s; if (Label1.getType() == AgpLabel.LABELTYPE_LABEL) s = "Label 1 is a Label for simple text display."; else if (Label1.getType() == AgpLabel.LABELTYPE_EXPRESSION_LINK) s = "Label 1 is an Expresssion Link for navigating to another page."; else if (Label1.getType() == AgpLabel.LABELTYPE_EVENT_LINK) s = "Label 1 is an Event Link for performing an action on this page.";
AgpLabel.getLinkTarget()
,
AgpLabel.getTargetFrame()
,
AgpLabel.setLinkTarget(String target)
,
AgpLabel.setTargetFrame(String targetFrame)
,
AgpLabel.setType(int type)
public void setType(int type)
type
- an int representing the type.
These constants refer to the possible values:
LABELTYPE_LABEL
- Label.LABELTYPE_EXPRESSION_LINK
- Expression.LABELTYPE_EVENT_LINK
- Event link.Label1.setType(AgpLabel.LABELTYPE_LABEL);
AgpLabel.getLinkTarget()
,
AgpLabel.getTargetFrame()
,
AgpLabel.setLinkTarget(String target)
,
AgpLabel.setTargetFrame(String targetFrame)
,
AgpLabel.getType()
public String getLinkTarget()
setType()
method.
The Link Target corresponds to the HREF
attribute of an HTML anchor (A
) tag.
AgpLabel.getType()
,
AgpLabel.getTargetFrame()
,
AgpLabel.setLinkTarget(String target)
,
AgpLabel.setTargetFrame(String targetFrame)
,
AgpLabel.setType(int type)
public void setLinkTarget(String target)
The Link Target corresponds to the HREF
attribute of an HTML anchor (A
) tag.
If this property is set at design time, using the URL Expression field in the Property Inspector, the design-time setting will always override any values set programmatically using this method.
target
- a string that specifies the link target.AgpLabel.getLinkTarget()
,
AgpLabel.getTargetFrame()
,
AgpLabel.setTargetFrame(String targetFrame)
,
AgpLabel.getType()
,
AgpLabel.setType(int type)
public String getTargetFrame()
setTargetFrame()
.
The Target Frame corresponds to the TARGET
attribute of an HTML anchor (A
) tag.
AgpLabel.getLinkTarget()
,
AgpLabel.setLinkTarget(String target)
,
AgpLabel.setTargetFrame(String targetFrame)
,
AgpLabel.getType()
,
AgpLabel.setType(int type)
public void setTargetFrame(String targetFrame)
The Target Frame corresponds to the TARGET
attribute of an HTML anchor (A
) tag.
targetFrame
- a String specifying the target frame.If this property is set at design time, using the URL Expression field in the Property Inspector, the design-time setting will always override any values set programmatically using this method.
AgpLabel.getLinkTarget()
,
AgpLabel.setLinkTarget(String target)
,
AgpLabel.setTargetFrame(String targetFrame)
,
AgpLabel.getType()
,
AgpLabel.setType(int type)
public boolean getRawHTMLMode()
if (Label1.getRawHTMLMode() == true) Label1.setText("Hello world!"); else Label1.setText("Hello world!");
AgpLabel.setRawHTMLMode(boolean israw)
public void setRawHTMLMode(boolean israw)
israw
- true
if control
should be in raw HTML mode, otherwise false
.Label1.setRawHTMLMode(true); Label1.setText("Hello world!
How are you?");
AgpLabel.getRawHTMLMode()
|
SilverStream Application Server 3.5 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |