com.sapportals.htmlb

Class HtmlEdit

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.HtmlEdit

public class HtmlEdit

extends Component

An editable TextArea

Copyright 2004 SAP AG

Field Summary

static String

UI_ID

Constructor Summary

HtmlEdit(String name)
Creates a html editor control

Method Summary

String	getAccessibilityDescription() Get the semantical description of the component in it's applicationcontext used by screenreaders
String	getAccessibilityInputPaneDescription() Get the semantical description of the editor's input pane used by screenreaders
HtmlEditDesign	getDesignConfiguration() Get the assigned design configuration.
boolean	getDoAlign() Is the "Alignment"-Function activated / deactivated - Left, Center, Right
boolean	getDoBackground() Is the "Background"-Function activated / deactivated
boolean	getDoBold() Is the "Bold"-Function activated / deactivated
boolean	getDoCutCopyPaste() Is the "Cut, Copy, Paste"-Function activated / deactivated
boolean	getDoDeleteTableColumn() Is the "Delete Table Column"-Function activated / deactivated
boolean	getDoDeleteTableRow() Is the "Delete Table Row"-Function activated / deactivated
boolean	getDoEditorsize() Is the "Editorsize"-Function activated / deactivated
boolean	getDoForeground() Is the "Foreground"-Function activated / deactivated
boolean	getDoImage() Is the "Insert Image/Link"-Function activated / deactivated
boolean	getDoInOutdent() Is the "In/Outdent"-Function activated / deactivated
boolean	getDoInsertDateAndTime() Is the Date & Time-Function activated / deactivated
boolean	getDoInsertExpander() Is the Size Expander activated / deactivated
boolean	getDoInsertTable() Is the "Insert Table"-Function activated / deactivated
boolean	getDoInsertTableColumn() Is the "Insert Table Column"-Function activated / deactivated
boolean	getDoInsertTableRow() Is the "Insert Table Row"-Function activated / deactivated
boolean	getDoItalic() Is the "Italic"-Function activated / deactivated
boolean	getDoJoinTableCell() Is the "Join Table Cell"-Function activated / deactivated
boolean	getDoJoinTableRow() Is the "Join Table Row"-Function activated / deactivated
boolean	getDoLink() Is the "Insert Link"-Function activated / deactivated
boolean	getDoLinkKM() Is the "Insert Link" KM-Function activated / deactivated
boolean	getDoList() Is the "List"-Function activated / deactivated - numbered and bullited List
boolean	getDoModifyTableColor() Is the "Modify Table Color"-Function activated / deactivated
boolean	getDoModifyTableProperties() Is the "Modify Table Properties"-Function activated / deactivated
boolean	getDoPreview() Is the Preview-Function activated / deactivated
boolean	getDoPrint() Is the Print-Function activated / deactivated
boolean	getDoStrikethrough() Is the "Strikethrough"-Function activated / deactivated
boolean	getDoStyle() Is the "Style"-Function activated / deactivated
boolean	getDoSuperSubScript() Is the "SuperSubscript"-Function activated / deactivated
boolean	getDoTextsize() Is the "Textsize"-Function activated / deactivated
boolean	getDoUnderline() Is the "Underline"-Function activated / deactivated
boolean	getDoUsePortalStyle() Is the Use Portal Style Function activated / deactivated
String	getHeight() Gets the height of the HtmlEdit control
int	getHorizontalScrollPosition() Get the horizontal scrolling position of the editor scrollContainer.
String	getImageHeight() Gets the HEIGHT of an Image to be overwritten
String	getImageSrc() Gets the SRC of an Image to be overwritten
String	getImageTooltip() Gets the ALT Parameter (Tooltip)of Image to be overwritten
String	getImageWidth() Gets the WIDTH of an Image to be overwritten
boolean	getInsertHorizontalLine() Is the "Insert Horizontal Line"-Function activated / deactivated
boolean	getInsertSpecialCharacter() Is the "Insert Special Character"-Function activated / deactivated
String	getLinkTarget() Gets the Target of a Link to be inserted (or a Link to be overwritten)
String	getLinkText() Gets the Text of Link to be inserted (or a Link to be overwritten)
String	getLinkURL() Gets the Target of a Link to be inserted (or a Link to be overwritten)
String	getOldId() Gets the oldId attribute of the HtmlEdit control
String	getOldText() Gets the old content of the control (before starting the insert of a Link / Image)
String	getOnDeleteTableColumn() Gets the Callback Method to be called if "DeleteTableColumn"-Function is activated
String	getOnDeleteTableRow() Gets the Callback Method to be called if "DeleteTableRow"-Function is activated
String	getOnInsertImage() Gets the the Callback Method to be called if "InsertImage"-Function is activated
String	getOnInsertLink() Gets the Callback Method to be called if "InsertLink"-Function is activated
String	getOnInsertTable() Gets the Callback Method to be called if "InsertTable"-Function is activated
String	getOnInsertTableColumn() Gets the Callback Method to be called if "InsertTableColumn"-Function is activated
String	getOnInsertTableRow() Gets the Callback Method to be called if "InsertTableRow"-Function is activated
String	getRedoBuffer() Get the actual user's redo buffer.
String	getSelectedScreenSize() Gets the previous screen size of the editor
String	getText() Gets the text attribute of the HtmlEdit object
String	getUI() Get unique component ID for a HtmlEdit
String	getUndoBuffer() Get the actual user's undo buffer.
int	getVerticalScrollPosition() Get the vertical scrolling position of the editor.
String	getWidth() Gets the width of the HtmlEdit control
protected void	initFromPageContext(IPageContext pc, String baseId) DoInitialisation from PageContext
boolean	isEditable() Get if the editor is in editable mode.
boolean	isExpandSize() Get if the editor is horizontal expanded.
void	setAccessibilityDescription(String accessibilityDescription) Sets the sematical description for the component in it's applicationcontext used by screenreaders
void	setAccessibilityInputPaneDescription(String accessibilityDescription) Sets the sematical description for the editor's input pane used by screenreaders
void	setDesignConfiguration(HtmlEditDesign design) Sets the html editor design to use
void	setDoAlign(boolean activate) Activate / Deactivate "Alignment" Function - Left, Center, Right
void	setDoBackground(boolean activate) Activate / Deactivate "Background" Function
void	setDoBold(boolean activate) Activate / Deactivate "Bold" Function
void	setDoCutCopyPaste(boolean activate) Activate / Deactivate "Cut, Copy, Paste" Function
void	setDoDeleteTableColumn(boolean activate) Activate / Deactivate "Delete Table Column" Function
void	setDoDeleteTableRow(boolean activate) Activate / Deactivate "Delete Table Row" Function
void	setDoEditorsize(boolean activate) Activate / Deactivate "Editorsize" Function
void	setDoForeground(boolean activate) Activate / Deactivate "Foreground" Function
void	setDoImage(boolean activate) Activate / Deactivate "Insert Image" Function
void	setDoInOutdent(boolean activate) Activate / Deactivate "In/Outdent" Function
void	setDoInsertDateAndTime(boolean activate) Activate / Deactivate Date & Time Function
void	setDoInsertExpander(boolean activate) Activate / Deactivate the size expander
void	setDoInsertTable(boolean activate) Activate / Deactivate "Insert Table" Function
void	setDoInsertTableColumn(boolean activate) Activate / Deactivate "Insert Table Column" Function
void	setDoInsertTableRow(boolean activate) Activate / Deactivate "Insert Table Row" Function
void	setDoItalic(boolean activate) Activate / Deactivate "Italic" Function
void	setDoJoinTableCell(boolean activate) Activate / Deactivate "Join Table Cell" Function
void	setDoJoinTableRow(boolean activate) Activate / Deactivate "Join Table Row" Function
void	setDoLink(boolean activate) Activate / Deactivate "Insert Link WEB" Function
void	setDoLinkKM(boolean activate) Activate / Deactivate "Insert Link KM" Function
void	setDoList(boolean activate) Activate / Deactivate "List" Function - numbered and bullited List
void	setDoModifyTableColor(boolean activate) Activate / Deactivate "Modify Table Color" Function
void	setDoModifyTableProperties(boolean activate) Activate / Deactivate "Modify Table Properties" Function
void	setDoPreview(boolean activate) Activate / Deactivate Preview Function
void	setDoPrint(boolean activate) Activate / Deactivate Print Function
void	setDoStrikethrough(boolean activate) Activate / Deactivate "Strikethrough" Function
void	setDoStyle(boolean activate) Activate / Deactivate "Style" Function
void	setDoSuperSubScript(boolean activate) Activate / Deactivate "Super/Sub - script" Function
void	setDoTextsize(boolean activate) Activate / Deactivate "Textsize" Function
void	setDoUnderline(boolean activate) Activate / Deactivate "Underline" Function
void	setDoUsePortalStyle(boolean activate) Activate / Deactivate Use Portal Style Function
void	setEditable(boolean editable) Set if the editor is in editable mode.
void	setExpandSize(boolean expanded) Set the horizontal expanded state.
void	setHeight(String height) Sets the height of the HtmlEdit control
void	setHorizontalScrollPosition(int horizontalPosition) Set the horizontal scrolling position of the editor.
void	setImageHeight(String height) Sets the HEIGHT of an Image to be inserted
void	setImageSrc(String image) Sets the SRC of an Image to be inserted
void	setImageTooltip(String tooltip) Sets ALT Parameter (Tooltip)of Image to be inserted
void	setImageWidth(String width) Sets the WIDTH of an Image to be inserted
void	setInsertHorizontalLine(boolean activate) Activate / Deactivate "Insert Horizontal Line" Function
void	setInsertSpecialCharacter(boolean activate) Activate / Deactivate "Insert Special Character" Function
void	setLinkTarget(String target) Sets the Target of a Link to be inserted
void	setLinkText(String link) Sets the Text of a Link to be inserted
void	setLinkURL(String link) Sets the HREF of a Link to be inserted
void	setOldId(String input) Sets the oldId attribute of the HtmlEdit control
void	setOldText(String input) Sets the previous content of the Control (before starting the insert of a Link / Image)
void	setOnDeleteTableColumn(String action) Sets the Callback Method to be called if "DeleteTableColumn"-Function is activated
void	setOnDeleteTableRow(String action) Sets the Callback Method to be called if "DeleteTableRow"-Function is activated
void	setOnInsertImage(String action) Sets the the Callback Method to be called if "InsertImage"-Function is activated
void	setOnInsertLink(String action) Sets the Callback Method to be called if "InsertLink"-Function is activated
void	setOnInsertTable(String action) Sets the Callback Method to be called if "InsertTable"-Function is activated
void	setOnInsertTableColumn(String action) Sets the Callback Method to be called if "InsertTableColumn"-Function is activated
void	setOnInsertTableRow(String action) Sets the Callback Method to be called if "InsertTableRow"-Function is activated
void	setRedoBuffer(String buffer) Set the redo of the actual user
void	setSelectedScreenSize(String size) Sets the previous screen size of the editor
void	setText(String input) Sets the content of Control
void	setUndoBuffer(String buffer) Set the undo of the actual user
void	setVerticalScrollPosition(int verticalPosition) Set the vertical scrolling position of the editor.
void	setWidth(String width) Sets the width of the HtmlEdit control

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromShortId, initializeFromId, isJsObjectNeeded, preRender, render, renderAsString, requiresForm, setId, setJsObjectNeeded, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UI_ID

public static final String UI_ID

See Also:

Constant Field Values

Constructor Detail

HtmlEdit

public HtmlEdit(String name)

Creates a html editor control

Parameters:

name - Name of HtmlEdit

Method Detail

getUI

public String getUI()

Get unique component ID for a HtmlEdit

Specified by:

getUI in class Component

Returns:

the UI id for the HtmlEdit

setText

public void setText(String input)

Sets the content of Control

Parameters:

input - content of control

getText

public String getText()

Gets the text attribute of the HtmlEdit object

Returns:

The content of control

setOldId

public void setOldId(String input)

Sets the oldId attribute of the HtmlEdit control

Parameters:

input - ID of the Control that was displayed previous (only for internal use)

getOldId

public String getOldId()

Gets the oldId attribute of the HtmlEdit control

Returns:

ID of the Control that was displayed previous (only for internal use)

setHeight

public void setHeight(String height)

Sets the height of the HtmlEdit control

Parameters:

height - The new height value

getHeight

public String getHeight()

Gets the height of the HtmlEdit control

Returns:

The height value

setWidth

public void setWidth(String width)

Sets the width of the HtmlEdit control

Parameters:

width - The new width value

getWidth

public String getWidth()

Gets the width of the HtmlEdit control

Returns:

The width value

setOldText

public void setOldText(String input)

Sets the previous content of the Control (before starting the insert of a Link / Image)

Parameters:

input - The old content

getOldText

public String getOldText()

Gets the old content of the control (before starting the insert of a Link / Image)

Returns:

The old content

setSelectedScreenSize

public void setSelectedScreenSize(String size)

Sets the previous screen size of the editor

getSelectedScreenSize

public String getSelectedScreenSize()

Gets the previous screen size of the editor

Returns:

The previous screen size

setLinkTarget

public void setLinkTarget(String target)

Sets the Target of a Link to be inserted

Parameters:

target - the TARGET of a Link

getLinkTarget

public String getLinkTarget()

Gets the Target of a Link to be inserted (or a Link to be overwritten)

Returns:

TARGET of a Link or null

setLinkURL

public void setLinkURL(String link)

Sets the HREF of a Link to be inserted

Parameters:

link - HREF of a Link

getLinkURL

public String getLinkURL()

Gets the Target of a Link to be inserted (or a Link to be overwritten)

Returns:

TARGET of a Link or null

setLinkText

public void setLinkText(String link)

Sets the Text of a Link to be inserted

Parameters:

link - HREF of a Link

getLinkText

public String getLinkText()

Gets the Text of Link to be inserted (or a Link to be overwritten)

Returns:

HREF of a Link

setImageSrc

public void setImageSrc(String image)

Sets the SRC of an Image to be inserted

Parameters:

image - SRC of the Image

getImageSrc

public String getImageSrc()

Gets the SRC of an Image to be overwritten

Returns:

SRC of an Image or null

setImageHeight

public void setImageHeight(String height)

Sets the HEIGHT of an Image to be inserted

Parameters:

height - HEIGHT of an Image

getImageHeight

public String getImageHeight()

Gets the HEIGHT of an Image to be overwritten

Returns:

The HEIGHT of an Image or null

setImageWidth

public void setImageWidth(String width)

Sets the WIDTH of an Image to be inserted

Parameters:

width - WIDTH of an Image

getImageWidth

public String getImageWidth()

Gets the WIDTH of an Image to be overwritten

Returns:

The WIDTH of an Image or null

setImageTooltip

public void setImageTooltip(String tooltip)

Sets ALT Parameter (Tooltip)of Image to be inserted

Parameters:

tooltip - ALT Parameter (Tooltip) of the Image

getImageTooltip

public String getImageTooltip()

Gets the ALT Parameter (Tooltip)of Image to be overwritten

Returns:

ALT Parameter (Tooltip) of the Image

setDoPrint

public void setDoPrint(boolean activate)

Activate / Deactivate Print Function

Parameters:

activate - Activate / Deactivate Function

getDoPrint

public boolean getDoPrint()

Is the Print-Function activated / deactivated

Returns:

Status of Print Function (activated / deactivated)

setDoPreview

public void setDoPreview(boolean activate)

Activate / Deactivate Preview Function

Parameters:

activate - Activate / Deactivate Function

getDoPreview

public boolean getDoPreview()

Is the Preview-Function activated / deactivated

Returns:

Status of Preview Function (activated / deactivated)

setDoInsertDateAndTime

public void setDoInsertDateAndTime(boolean activate)

Activate / Deactivate Date & Time Function

Parameters:

activate - Activate / Deactivate Function

getDoInsertDateAndTime

public boolean getDoInsertDateAndTime()

Is the Date & Time-Function activated / deactivated

Returns:

Status of Date & Time Function (activated / deactivated)

setDoCutCopyPaste

public void setDoCutCopyPaste(boolean activate)

Activate / Deactivate "Cut, Copy, Paste" Function

Parameters:

activate - Activate / Deactivate Function

getDoCutCopyPaste

public boolean getDoCutCopyPaste()

Is the "Cut, Copy, Paste"-Function activated / deactivated

Returns:

Status of "Cut, Copy, Paste" Function (activated / deactivated)

setDoList

public void setDoList(boolean activate)

Activate / Deactivate "List" Function - numbered and bullited List

Parameters:

activate - Activate / Deactivate Function

getDoList

public boolean getDoList()

Is the "List"-Function activated / deactivated - numbered and bullited List

Returns:

Status of "List" Function (activated / deactivated)

setDoAlign

public void setDoAlign(boolean activate)

Activate / Deactivate "Alignment" Function - Left, Center, Right

Parameters:

activate - Activate / Deactivate Function

getDoAlign

public boolean getDoAlign()

Is the "Alignment"-Function activated / deactivated - Left, Center, Right

Returns:

Status of "Alignment" Function (activated / deactivated)

setDoInOutdent

public void setDoInOutdent(boolean activate)

Activate / Deactivate "In/Outdent" Function

Parameters:

activate - Activate / Deactivate Function

getDoInOutdent

public boolean getDoInOutdent()

Is the "In/Outdent"-Function activated / deactivated

Returns:

Status of "In/Outdent"nt Function (activated / deactivated)

setDoLink

public void setDoLink(boolean activate)

Activate / Deactivate "Insert Link WEB" Function

Parameters:

activate - Activate / Deactivate Function

getDoLink

public boolean getDoLink()

Is the "Insert Link"-Function activated / deactivated

Returns:

Status of "Insert Image/Link WEB" Function (activated / deactivated)

setDoInsertTable

public void setDoInsertTable(boolean activate)

Activate / Deactivate "Insert Table" Function

Parameters:

activate - Activate / Deactivate Function

getDoInsertTable

public boolean getDoInsertTable()

Is the "Insert Table"-Function activated / deactivated

Returns:

Status of "Insert Table" Function (activated / deactivated)

setDoInsertTableColumn

public void setDoInsertTableColumn(boolean activate)

Activate / Deactivate "Insert Table Column" Function

Parameters:

activate - Activate / Deactivate Function

setDoInsertTableRow

public void setDoInsertTableRow(boolean activate)

Activate / Deactivate "Insert Table Row" Function

Parameters:

activate - Activate / Deactivate Function

getDoInsertTableColumn

public boolean getDoInsertTableColumn()

Is the "Insert Table Column"-Function activated / deactivated

Returns:

Status of "Insert Table Column" Function (activated / deactivated)

setDoDeleteTableColumn

public void setDoDeleteTableColumn(boolean activate)

Activate / Deactivate "Delete Table Column" Function

Parameters:

activate - Activate / Deactivate Function

getDoInsertTableRow

public boolean getDoInsertTableRow()

Is the "Insert Table Row"-Function activated / deactivated

Returns:

Status of "Insert Table Row" Function (activated / deactivated)

setDoDeleteTableRow

public void setDoDeleteTableRow(boolean activate)

Activate / Deactivate "Delete Table Row" Function

Parameters:

activate - Activate / Deactivate Function

getDoJoinTableCell

public boolean getDoJoinTableCell()

Is the "Join Table Cell"-Function activated / deactivated

Returns:

Status of "Join Table Cell" Function (activated / deactivated)

setDoJoinTableCell

public void setDoJoinTableCell(boolean activate)

Activate / Deactivate "Join Table Cell" Function

Parameters:

activate - Activate / Deactivate Function

getDoJoinTableRow

public boolean getDoJoinTableRow()

Is the "Join Table Row"-Function activated / deactivated

Returns:

Status of "Join Table Row" Function (activated / deactivated)

setDoJoinTableRow

public void setDoJoinTableRow(boolean activate)

Activate / Deactivate "Join Table Row" Function

Parameters:

activate - Activate / Deactivate Function

getDoModifyTableColor

public boolean getDoModifyTableColor()

Is the "Modify Table Color"-Function activated / deactivated

Returns:

Status of "Modify Table Color" Function (activated / deactivated)

setDoModifyTableColor

public void setDoModifyTableColor(boolean activate)

Activate / Deactivate "Modify Table Color" Function

Parameters:

activate - Activate / Deactivate Function

getDoModifyTableProperties

public boolean getDoModifyTableProperties()

Is the "Modify Table Properties"-Function activated / deactivated

Returns:

Status of "Modify Table Properties" Function (activated / deactivated)

setDoModifyTableProperties

public void setDoModifyTableProperties(boolean activate)

Activate / Deactivate "Modify Table Properties" Function

Parameters:

activate - Activate / Deactivate Function

getInsertSpecialCharacter

public boolean getInsertSpecialCharacter()

Is the "Insert Special Character"-Function activated / deactivated

Returns:

Status of "Insert Special Character" Function (activated / deactivated)

setInsertSpecialCharacter

public void setInsertSpecialCharacter(boolean activate)

Activate / Deactivate "Insert Special Character" Function

Parameters:

activate - Activate / Deactivate Function

getDoDeleteTableColumn

public boolean getDoDeleteTableColumn()

Is the "Delete Table Column"-Function activated / deactivated

Returns:

Status of "Delete Table Column" Function (activated / deactivated)

getDoDeleteTableRow

public boolean getDoDeleteTableRow()

Is the "Delete Table Row"-Function activated / deactivated

Returns:

Status of "Delete Table Row" Function (activated / deactivated)

setDoLinkKM

public void setDoLinkKM(boolean activate)

Activate / Deactivate "Insert Link KM" Function

Parameters:

activate - Activate / Deactivate Function

getDoLinkKM

public boolean getDoLinkKM()

Is the "Insert Link" KM-Function activated / deactivated

Returns:

Status of "Insert Image/Link" Function (activated / deactivated)

setDoImage

public void setDoImage(boolean activate)

Activate / Deactivate "Insert Image" Function

Parameters:

activate - Activate / Deactivate Function

getDoImage

public boolean getDoImage()

Is the "Insert Image/Link"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

getInsertHorizontalLine

public boolean getInsertHorizontalLine()

Is the "Insert Horizontal Line"-Function activated / deactivated

Returns:

Status of "Insert Horizontal Line" Function (activated / deactivated)

setInsertHorizontalLine

public void setInsertHorizontalLine(boolean activate)

Activate / Deactivate "Insert Horizontal Line" Function

Parameters:

activate - Activate / Deactivate Function

setDoBold

public void setDoBold(boolean activate)

Activate / Deactivate "Bold" Function

Parameters:

activate - Activate / Deactivate Function

getDoBold

public boolean getDoBold()

Is the "Bold"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

setDoItalic

public void setDoItalic(boolean activate)

Activate / Deactivate "Italic" Function

Parameters:

activate - Activate / Deactivate Function

getDoItalic

public boolean getDoItalic()

Is the "Italic"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

setDoUnderline

public void setDoUnderline(boolean activate)

Activate / Deactivate "Underline" Function

Parameters:

activate - Activate / Deactivate Function

getDoUnderline

public boolean getDoUnderline()

Is the "Underline"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

setDoStrikethrough

public void setDoStrikethrough(boolean activate)

Activate / Deactivate "Strikethrough" Function

Parameters:

activate - Activate / Deactivate Function

getDoStrikethrough

public boolean getDoStrikethrough()

Is the "Strikethrough"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

setDoSuperSubScript

public void setDoSuperSubScript(boolean activate)

Activate / Deactivate "Super/Sub - script" Function

Parameters:

activate - Activate / Deactivate Function

getDoSuperSubScript

public boolean getDoSuperSubScript()

Is the "SuperSubscript"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

setDoStyle

public void setDoStyle(boolean activate)

Activate / Deactivate "Style" Function

Parameters:

activate - Activate / Deactivate Function

getDoStyle

public boolean getDoStyle()

Is the "Style"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

setDoTextsize

public void setDoTextsize(boolean activate)

Activate / Deactivate "Textsize" Function

Parameters:

activate - Activate / Deactivate Function

getDoTextsize

public boolean getDoTextsize()

Is the "Textsize"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

setDoEditorsize

public void setDoEditorsize(boolean activate)

Activate / Deactivate "Editorsize" Function

Parameters:

activate - Activate / Deactivate Function

getDoEditorsize

public boolean getDoEditorsize()

Is the "Editorsize"-Function activated / deactivated

Returns:

Status of "Editorsize" Function (activated / deactivated)

setDoForeground

public void setDoForeground(boolean activate)

Activate / Deactivate "Foreground" Function

Parameters:

activate - Activate / Deactivate Function

getDoForeground

public boolean getDoForeground()

Is the "Foreground"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

setDoBackground

public void setDoBackground(boolean activate)

Activate / Deactivate "Background" Function

Parameters:

activate - Activate / Deactivate Function

getDoBackground

public boolean getDoBackground()

Is the "Background"-Function activated / deactivated

Returns:

Status of "Insert Image" Function (activated / deactivated)

setOnInsertLink

public void setOnInsertLink(String action)

Sets the Callback Method to be called if "InsertLink"-Function is activated

Parameters:

action - name of method

getOnInsertLink

public String getOnInsertLink()

Gets the Callback Method to be called if "InsertLink"-Function is activated

Returns:

name of Method

setOnInsertTable

public void setOnInsertTable(String action)

Sets the Callback Method to be called if "InsertTable"-Function is activated

Parameters:

action - name of method

setOnInsertTableRow

public void setOnInsertTableRow(String action)

Sets the Callback Method to be called if "InsertTableRow"-Function is activated

Parameters:

action - name of method

getOnInsertTableRow

public String getOnInsertTableRow()

Gets the Callback Method to be called if "InsertTableRow"-Function is activated

Returns:

name of Method

setOnDeleteTableRow

public void setOnDeleteTableRow(String action)

Sets the Callback Method to be called if "DeleteTableRow"-Function is activated

Parameters:

action - name of method

getOnDeleteTableRow

public String getOnDeleteTableRow()

Gets the Callback Method to be called if "DeleteTableRow"-Function is activated

Returns:

name of Method

setOnInsertTableColumn

public void setOnInsertTableColumn(String action)

Sets the Callback Method to be called if "InsertTableColumn"-Function is activated

Parameters:

action - name of method

getOnInsertTableColumn

public String getOnInsertTableColumn()

Gets the Callback Method to be called if "InsertTableColumn"-Function is activated

Returns:

name of Method

setOnDeleteTableColumn

public void setOnDeleteTableColumn(String action)

Sets the Callback Method to be called if "DeleteTableColumn"-Function is activated

Parameters:

action - name of method

getOnDeleteTableColumn

public String getOnDeleteTableColumn()

Gets the Callback Method to be called if "DeleteTableColumn"-Function is activated

Returns:

name of Method

getOnInsertTable

public String getOnInsertTable()

Gets the Callback Method to be called if "InsertTable"-Function is activated

Returns:

name of Method

setOnInsertImage

public void setOnInsertImage(String action)

Sets the the Callback Method to be called if "InsertImage"-Function is activated

Parameters:

action - name of Method

getOnInsertImage

public String getOnInsertImage()

Gets the the Callback Method to be called if "InsertImage"-Function is activated

Returns:

name of Method

initFromPageContext

protected void initFromPageContext(IPageContext pc,
                                   String baseId)

DoInitialisation from PageContext

Overrides:

initFromPageContext in class Component

Parameters:

pc - PageContext

baseId - ID of Control

getAccessibilityDescription

public String getAccessibilityDescription()

Get the semantical description of the component in it's applicationcontext used by screenreaders

Returns:

description text

setAccessibilityDescription

public void setAccessibilityDescription(String accessibilityDescription)

Sets the sematical description for the component in it's applicationcontext used by screenreaders

Parameters:

accessibilityDescription - description text

getDesignConfiguration

public HtmlEditDesign getDesignConfiguration()

Get the assigned design configuration.

Returns:

html edit design

setDesignConfiguration

public void setDesignConfiguration(HtmlEditDesign design)

Sets the html editor design to use

getVerticalScrollPosition

public int getVerticalScrollPosition()

Get the vertical scrolling position of the editor.

Returns:

the vertical scrolling position of the editor

setVerticalScrollPosition

public void setVerticalScrollPosition(int verticalPosition)

Set the vertical scrolling position of the editor.

Parameters:

verticalPosition - the vertical scrolling position of the editor

getHorizontalScrollPosition

public int getHorizontalScrollPosition()

Get the horizontal scrolling position of the editor scrollContainer.

Returns:

the horizontal scrolling position of the editor

setHorizontalScrollPosition

public void setHorizontalScrollPosition(int horizontalPosition)

Set the horizontal scrolling position of the editor.

Parameters:

horizontalPosition - the horizontal scrolling position of the editor

getUndoBuffer

public String getUndoBuffer()

Get the actual user's undo buffer.

Returns:

undo buffer

setUndoBuffer

public void setUndoBuffer(String buffer)

Set the undo of the actual user

getRedoBuffer

public String getRedoBuffer()

Get the actual user's redo buffer.

Returns:

redo buffer

setRedoBuffer

public void setRedoBuffer(String buffer)

Set the redo of the actual user

isExpandSize

public boolean isExpandSize()

Get if the editor is horizontal expanded.

Returns:

horizontal expanded state

setExpandSize

public void setExpandSize(boolean expanded)

Set the horizontal expanded state.

Parameters:

expanded - state

setEditable

public void setEditable(boolean editable)

Set if the editor is in editable mode.

Parameters:

editable -

isEditable

public boolean isEditable()

Get if the editor is in editable mode.

Returns:

the current editable mode

getAccessibilityInputPaneDescription

public String getAccessibilityInputPaneDescription()

Get the semantical description of the editor's input pane used by screenreaders

Returns:

description text

setAccessibilityInputPaneDescription

public void setAccessibilityInputPaneDescription(String accessibilityDescription)

Sets the sematical description for the editor's input pane used by screenreaders

Parameters:

accessibilityDescription - description text

setDoUsePortalStyle

public void setDoUsePortalStyle(boolean activate)

Activate / Deactivate Use Portal Style Function

Parameters:

activate - Activate / Deactivate Function

getDoUsePortalStyle

public boolean getDoUsePortalStyle()

Is the Use Portal Style Function activated / deactivated

Returns:

Status of "List" Function (activated / deactivated)

setDoInsertExpander

public void setDoInsertExpander(boolean activate)

Activate / Deactivate the size expander

Parameters:

activate - Activate / Deactivate

getDoInsertExpander

public boolean getDoInsertExpander()

Is the Size Expander activated / deactivated

Returns:

Status of size expander functionality (activated / deactivated)