com.liferay.faces.portal.component.inputrichtext

Class InputRichTextBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

com.liferay.faces.portal.component.inputrichtext.InputRichTextBase

All Implemented Interfaces:

com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

InputRichText

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class InputRichTextBase
extends javax.faces.component.UIInput
implements com.liferay.faces.util.component.Styleable

Author:

Neil Griffin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	InputRichTextBase.InputRichTextPropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface com.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Constructor Summary

Constructors

Constructor and Description
InputRichTextBase()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getConfigParams() configParams attribute description:
String	getContentsLanguageId() contentsLanguageId attribute description:
String	getEditorKey() editorKey attribute description:
Map<String,String>	getFileBrowserParams() fileBrowserParams attribute description:
String	getLabel() label attribute description:
int	getMaxPlainTextChars() maxPlainTextChars attribute description:
int	getMinPlainTextChars() minPlainTextChars attribute description:
String	getOnblur() onblur attribute description:
String	getOnchange() onchange attribute description:
String	getOnfocus() onfocus attribute description:
String	getStyle() style attribute description:
String	getStyleClass() styleClass attribute description:
String	getToolbarSet() toolbarSet attribute description:
boolean	isResizable() resizable attribute description:
boolean	isSkipEditorLoading() skipEditorLoading attribute description:
void	setConfigParams(Map<String,String> configParams) configParams attribute description:
void	setContentsLanguageId(String contentsLanguageId) contentsLanguageId attribute description:
void	setEditorKey(String editorKey) editorKey attribute description:
void	setFileBrowserParams(Map<String,String> fileBrowserParams) fileBrowserParams attribute description:
void	setLabel(String label) label attribute description:
void	setMaxPlainTextChars(int maxPlainTextChars) maxPlainTextChars attribute description:
void	setMinPlainTextChars(int minPlainTextChars) minPlainTextChars attribute description:
void	setOnblur(String onblur) onblur attribute description:
void	setOnchange(String onchange) onchange attribute description:
void	setOnfocus(String onfocus) onfocus attribute description:
void	setResizable(boolean resizable) resizable attribute description:
void	setSkipEditorLoading(boolean skipEditorLoading) skipEditorLoading attribute description:
void	setStyle(String style) style attribute description:
void	setStyleClass(String styleClass) styleClass attribute description:
void	setToolbarSet(String toolbarSet) toolbarSet attribute description:

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

InputRichTextBase

public InputRichTextBase()

Method Detail

getConfigParams

public Map<String,String> getConfigParams()

configParams attribute description:

Optional map of configuration parameters. For example usage, see the Wiki portlet editor_config.jsp source code.

setConfigParams

public void setConfigParams(Map<String,String> configParams)

configParams attribute description:

Optional map of configuration parameters. For example usage, see the Wiki portlet editor_config.jsp source code.

getContentsLanguageId

public String getContentsLanguageId()

contentsLanguageId attribute description:

The locale (language id) of the rich text content.

setContentsLanguageId

public void setContentsLanguageId(String contentsLanguageId)

contentsLanguageId attribute description:

The locale (language id) of the rich text content.

getEditorKey

public String getEditorKey()

editorKey attribute description:

Liferay Portal property key name (typically found in portal.properties or portal-ext.properties). Valid property key values are "ckeditor", "ckeditor_bbcode", and "ckeditor_creole". The default key name is "editor.wysiwyg.default" which has a value of "ckeditor".

setEditorKey

public void setEditorKey(String editorKey)

editorKey attribute description:

Liferay Portal property key name (typically found in portal.properties or portal-ext.properties). Valid property key values are "ckeditor", "ckeditor_bbcode", and "ckeditor_creole". The default key name is "editor.wysiwyg.default" which has a value of "ckeditor".

getFileBrowserParams

public Map<String,String> getFileBrowserParams()

fileBrowserParams attribute description:

Optional map of file browser parameters. For example usage, see the Wiki portlet editor_config.jsp source code.

setFileBrowserParams

public void setFileBrowserParams(Map<String,String> fileBrowserParams)

fileBrowserParams attribute description:

Optional map of file browser parameters. For example usage, see the Wiki portlet editor_config.jsp source code.

getLabel

public String getLabel()

label attribute description:

A localized label for this component that is typically only rendered in a FacesMessage when validation fails.

setLabel

public void setLabel(String label)

label attribute description:

A localized label for this component that is typically only rendered in a FacesMessage when validation fails.

getMaxPlainTextChars

public int getMaxPlainTextChars()

maxPlainTextChars attribute description:

The maximum number of plain text characters, meaning characters that do not include HTML tags such as <strong>, <em>, and <a href="...">.

setMaxPlainTextChars

public void setMaxPlainTextChars(int maxPlainTextChars)

maxPlainTextChars attribute description:

The maximum number of plain text characters, meaning characters that do not include HTML tags such as <strong>, <em>, and <a href="...">.

getMinPlainTextChars

public int getMinPlainTextChars()

minPlainTextChars attribute description:

The minimum number of plain text characters, meaning characters that do not include HTML tags such as <strong>, <em>, and <a href="...">.

setMinPlainTextChars

public void setMinPlainTextChars(int minPlainTextChars)

minPlainTextChars attribute description:

The minimum number of plain text characters, meaning characters that do not include HTML tags such as <strong>, <em>, and <a href="...">.

getOnblur

public String getOnblur()

onblur attribute description:

Javascript to execute after this component loses focus.

setOnblur

public void setOnblur(String onblur)

onblur attribute description:

Javascript to execute after this component loses focus.

getOnchange

public String getOnchange()

onchange attribute description:

Javascript to execute after this component's value has changed, and then it loses focus.

setOnchange

public void setOnchange(String onchange)

onchange attribute description:

Javascript to execute after this component's value has changed, and then it loses focus.

getOnfocus

public String getOnfocus()

onfocus attribute description:

Javascript to execute when this component gets focus.

setOnfocus

public void setOnfocus(String onfocus)

onfocus attribute description:

Javascript to execute when this component gets focus.

isResizable

public boolean isResizable()

resizable attribute description:

When true, the will be resizable by the end-user when dragging on the bottom-right resize handle.

setResizable

public void setResizable(boolean resizable)

resizable attribute description:

When true, the will be resizable by the end-user when dragging on the bottom-right resize handle.

isSkipEditorLoading

public boolean isSkipEditorLoading()

skipEditorLoading attribute description:

When true, the resources necessary for loading the CKEditor will not be added to the <head>...</head> section of the portal page.

setSkipEditorLoading

public void setSkipEditorLoading(boolean skipEditorLoading)

skipEditorLoading attribute description:

When true, the resources necessary for loading the CKEditor will not be added to the <head>...</head> section of the portal page.

getStyle

public String getStyle()

style attribute description:

HTML passthrough attribute specifying the css style of the element.

Specified by:

getStyle in interface com.liferay.faces.util.component.Styleable

setStyle

public void setStyle(String style)

style attribute description:

HTML passthrough attribute specifying the css style of the element.

Specified by:

setStyle in interface com.liferay.faces.util.component.Styleable

getStyleClass

public String getStyleClass()

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

setStyleClass

public void setStyleClass(String styleClass)

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

setStyleClass in interface com.liferay.faces.util.component.Styleable

getToolbarSet

public String getToolbarSet()

toolbarSet attribute description:

The name of the set of toolbars that are to be displayed above the rich text input area. Valid values include:

• bbcode
• creole
• editInPlace
• email
• liferay
• liferayArticle
• phone
• simple
• tablet

The default value depends on the value of the editorKey attribute. If editorKey's property evaluates to "ckeditor" then the default value is "liferay". If editorKey's property evaluates to "ckeditor_bbcode" then the default value is "bbcode". If editorKey's property evaluates to "ckeditor_creole" then the default value is "creole".

setToolbarSet

public void setToolbarSet(String toolbarSet)

toolbarSet attribute description:

The name of the set of toolbars that are to be displayed above the rich text input area. Valid values include:

• bbcode
• creole
• editInPlace
• email
• liferay
• liferayArticle
• phone
• simple
• tablet

The default value depends on the value of the editorKey attribute. If editorKey's property evaluates to "ckeditor" then the default value is "liferay". If editorKey's property evaluates to "ckeditor_bbcode" then the default value is "bbcode". If editorKey's property evaluates to "ckeditor_creole" then the default value is "creole".