Show TOC Start of Content Area

Object documentation HTML Edit  Locate the document in its SAP Library structure

Definition

A multiline region for displaying and editing text - similar to control textEdit. The difference to textEdit is, that the text in the control is not restricted to a single font, size and style. The htmlEdit control is a WYSIWYG editor that produces HTML documents. Formatting options include:

·        Bold, italic and underlined text.

·        Bulleted and numbered lists.

·        Text fonts, text size and text color can be selected.

·        Links and images can be added.

This control is available for web browser Internet Explorer Version 5.x and higher.

·        id

Identification name of the htmlEdit control.

·        doAlign

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Alignment" functions - left, center and right Alignment.

·        doBackground

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Background" function for text.

·        doBold

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Bold-Characters" functions.

·        doCutCopyPaste

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Cut, Copy and Paste" functions.

·        doForeground

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Foreground" function for text (text color).

·        doImage

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Insert Image" function.

·        doInOutdent

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Increase Indent/Decrease Indent" function.

·        doItalic

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Italic-Characters" function.

·        doLink

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Insert Link to the Web" function.

·        doLinkKM

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Insert Link to the Knowledge Management (KM) " function.

·        doList

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Bulleted/Numbered List" functions.

·        doPreview

A boolean value that activates (=TRUE) or deactivates (=FALSE) the document "Preview" function.

·        doPrint

A boolean value that activates (=TRUE) or deactivates (=FALSE) the document "Print" function.

·        doStrikethrough

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Strikethrough" function.

·        doStyle

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Style" function.

·        doSuperSubScript

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Super/Sub script" function.

·        doTextsize

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Textsize" function.

·        doUnderline

A boolean value that activates (=TRUE) or deactivates (=FALSE) the "Underline" function.

·        height

Defines the height of the htmlEdit control.

·        imageHeight

Defines the height of the image to be inserted.

·        imageSrc

Defines the name of the image to be inserted.

·        imageTooltip

Defines the tooltip for the image.

·        imageWidth

Defines the width of the image to be inserted.

·        linkTarget

Defines the target of the link to be inserted. The following values refer to w3c HTML-standard.

¡        _blank

The web client should load the designated document in a new, unnamed window.

¡        _self

The web client should load the document in the same frame as the element that refers to the target.

¡        _parent

The web client should load the document into the immediate FRAMESET parent of the current frame. This value is equivalent to _self if the current frame has no parent.

¡        _top

The web client should load the document into the full, original window (thus canceling all other frames). This value is equivalent to _self if the current frame has no parent.

·        linkText

Defines the text of the link to be inserted.

·        linkURL

Defines the URL (href=) of the link to be inserted.

·        oldId

Defines the oldId attribute for the htmlEdit control.

·        oldText

Defines the previous content of the control. The previous content is the content before you start an "insert image" or "insert link" function.

·        onInsertImage

Defines the event handling method that will be processed when the user activates the "Insert Image" function.

·        onInsertLink

Defines the event handling method that will be processed when the user activates the "Insert Link" function.

·        text

Defines the string of text displayed. This text can be edited and/or new text can be added.

·        width

Defines the width of the htmlEdit control.

 

Attributes

M

Values

Usage

id

*

String (cs)

 

Taglib
id="htmlEdit"

Classlib
setId ("htemlEdit")

doAlign

 

FALSE (d)
TRUE

Taglib
doAlign="TRUE"

Classlib
setDoAlign(true)

doBackground

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoBackground(true)

doBold

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoBold(true)

doCutCopyPaste

 

FALSE (d)
TRUE

Taglib
doCutCopyPaste"TRUE"

Classlib
setDoCutCopyPaste (true)

doForeground

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoForeground(true)

doImage

 

FALSE (d)
TRUE

Taglib
doImageLink="TRUE"

Classlib
setDoImage(true)

doInOutDent

 

FALSE (d)
TRUE

Taglib
doInOutDent="TRUE"

Classlib
setDoInOutDent (true)

doItalic

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoItalic(true)

doLink

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoLink(true)

doLinkKM

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoLinkKM(true)

doList

 

FALSE (d)
TRUE

Taglib
doList="TRUE"

Classlib
setDoList(true)

doPreview

 

FALSE (d)
TRUE

Taglib
doPreview="TRUE"

Classlib
setDoPreview(true)

doPrint

 

FALSE (d)
TRUE

Taglib
doAlign="TRUE"

Classlib
setDoAlign(true)

doStandardEdit

 

FALSE (d)
TRUE

Taglib
doStandardEdit="TRUE"

Classlib
No method available

doStrikethrough

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoStrikethrough(true)

doStyle

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoStyle(true)

doSuperSubScript

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoSuperSubScript(true)

doTextsize

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoTextsizetrue)

doUnderline

 

FALSE (d)
TRUE

Taglib
No tag available

Classlib
setDoUnderline(true)

height

 

Unit

Taglib
height="300px"

Classlib
setHeight("300px")

imageHeight

 

Unit

Taglib
No tag available

Classlib
setImageHeight("100px")

imageSrc

 

String

Taglib
No tag available

Classlib
setImageSrc("SAPLogo.gif")

imageTooltip

 

String

Taglib
No tag available

Classlib
setImageToolTip("SAP Logo")

imageWidth

 

Unit

Taglib
No tag available

Classlib
setImageWidth("100px")

linkTarget

 

_blank
_self
_parent
_top

Taglib
No tag available

Classlib
setLinkTarget("_top")

linkText

 

String

Taglib
No tag available

Classlib
setLinkText("Go to SAP")

linkURL

 

String

Taglib
No tag available

Classlib
setLinkURL("http://www.sap.com")

oldId

 

String

Taglib
No tag available

Classlib
setOldId("prevID")

oldText

 

String

Taglib
No tag available

Classlib
setOldText("Episode I")

text

 

String

Taglib
text="The Star Wars Saga"

Classlib
setText("The Star Wars Saga")

width

 

Unit

Taglib
width="400px"

Classlib
setWidth("400px")

 

Events

M

Values

Usage

onInsertImage

 

String (cs)

Taglib
oninsertImage="onImage"

Classlib
setOninsertImage("onImage")

onInsertLink

 

String (cs)

Taglib
onInsertLink="onLink"

Classlib
setOnInsertLink="onLink"

 

Example

using the taglib

 <hbj:htmlEdit 
    id="htmlEdit" 
    text="The Star Wars Saga" 
    height="200" 
    width="300" 
    doPrint="TRUE" 
    doPreview="TRUE" 
    doCutCopyPaste="TRUE" 
    doList="TRUE" 
    doAlign="TRUE" 
    doInOutdent="TRUE" 
    onInsertLink="onLink" 
    onInsertImage="onImage" 
    />

 

using the classlib

    Form form = (Form) this.getForm();
    HtmlEdit he = new HtmlEdit("myNavigation");
    he.setText("The Star Wars Saga");
    he.setHeight("200");
    he.setWidth("300");
    he.setDoPrint(true);
    he.setDoPreview(true);
    he.setDoCutCopyPaste(true);
    he.setDoList(true);
    he.setDoAlign(true);
    he.setDoInOutdent(true);
    he.setOnInsertLink("onLink");
    he.setOnInsertImage("onImage");
    form.addComponent(he);

 

Result

This graphic is explained in the accompanying text

 

 

End of Content Area