com.ibm.workplace.wcm.api.authoring
Interface EditorBean

public interface EditorBean

Method Summary

java.lang.String	getDirection() Returns the default text direction of this editor control.
java.lang.String	getHeight() Returns the pixel height of this editor component.
java.lang.String	getHiddenContentFieldName() Returns the name of the hidden form field that will be used to accept editor content.
java.lang.String	getName()
java.lang.String	getStyleSheetURL()
java.lang.String	getWidth() Returns the pixel width of this editor component.
boolean	isEditable() Returns the editable status of this component.
boolean	isFormattingControlsHidden() Indicates whether the formatting controls should be hidden from the user when the editor is rendered..
boolean	isHTMLModeHidden() Indicates whether the HTML mode should be hidden from the user when the editor is rendered.
boolean	isLimitedToLibraryImagePicker() Indicates whether the Image picker dialog will be limited to library images, and not allow users to upload their own images.

Method Detail

isEditable

boolean isEditable()

Returns the editable status of this component.

Returns:

Returns the editable status of this component. Returns false if the editor should not be displayed in an editable configuration.

getName

java.lang.String getName()

Returns:

Returns the unique name of this editor.

getHiddenContentFieldName

java.lang.String getHiddenContentFieldName()

Returns the name of the hidden form field that will be used to accept editor content. Editor content is transferred in this field when the save button is pressed.

Returns:

Name of hidden form field that will be used to accept editor content.

getHeight

java.lang.String getHeight()

Returns the pixel height of this editor component.

Returns:

The pixel height of this editor component.

getWidth

java.lang.String getWidth()

Returns the pixel width of this editor component.

Returns:

The pixel width of this editor component.

getDirection

java.lang.String getDirection()

Returns the default text direction of this editor control. Returns either "ltr" or "rtl".

Returns:

The default text direction of this editor control.

getStyleSheetURL

java.lang.String getStyleSheetURL()

Returns:

Returns the style sheet URL of this editor control.

isFormattingControlsHidden

boolean isFormattingControlsHidden()

Indicates whether the formatting controls should be hidden from the user when the editor is rendered..

Returns:

boolean true if the formatting controls should be hidden for the user. If the controls should be shown then false will be returned.

isHTMLModeHidden

boolean isHTMLModeHidden()

Indicates whether the HTML mode should be hidden from the user when the editor is rendered.

Returns:

boolean true if the HTML mode should be hidden for the user.

isLimitedToLibraryImagePicker

boolean isLimitedToLibraryImagePicker()

Indicates whether the Image picker dialog will be limited to library images, and not allow users to upload their own images.

Returns:

boolean true if the image picker should be limited to library images.