org.primefaces.extensions.component.ckeditor
Class CKEditor

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.html.HtmlInputTextarea
                      org.primefaces.extensions.component.ckeditor.CKEditor

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, 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, org.primefaces.component.api.Widget

public class CKEditor
extends javax.faces.component.html.HtmlInputTextarea
implements javax.faces.component.behavior.ClientBehaviorHolder, org.primefaces.component.api.Widget

Component class for the CKEditor component.

Since:

0.2

Version:

$Revision$

Author:

Thomas Andraschko / last modified by $Author$

Nested Class Summary

protected static class

CKEditor.PropertyKeys Properties that are tracked by state saving.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	EVENT_BLUR
static java.lang.String	EVENT_CHANGE Event, which will be fired after blur, when the content has been changed.
static java.lang.String	EVENT_DIRTY Event, which will be fired after the content has been changed (without blur before).
static java.lang.String	EVENT_FOCUS
static java.lang.String	EVENT_INITIALIZE
static java.lang.String	EVENT_SAVE
static java.lang.String	EVENT_SOURCE_MODE
static java.lang.String	EVENT_WYSIWYG_MODE

Fields inherited from class javax.faces.component.UIInput

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

Constructor Summary

CKEditor()

Method Summary

int	getCheckDirtyInterval()
java.lang.String	getContentsCss()
java.lang.String	getCustomConfig()
java.lang.String	getDefaultEventName()
java.lang.String	getDefaultLanguage()
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getHeight()
java.lang.String	getInterfaceColor()
java.lang.String	getLanguage()
java.lang.String	getSkin()
java.lang.String	getTabindex()
java.lang.String	getTheme()
java.lang.String	getToolbar()
java.lang.String	getWidgetVar()
java.lang.String	getWidth()
boolean	isEscape()
boolean	isReadOnly()
java.lang.String	resolveWidgetVar()
void	setAttribute(CKEditor.PropertyKeys property, java.lang.Object value)
void	setCheckDirtyInterval(int checkDirtyInterval)
void	setContentsCss(java.lang.String contentsCss)
void	setCustomConfig(java.lang.String customConfig)
void	setDefaultLanguage(java.lang.String defaultLanguage)
void	setEscape(boolean escape)
void	setHeight(java.lang.String height)
void	setInterfaceColor(java.lang.String interfaceColor)
void	setLanguage(java.lang.String language)
void	setReadOnly(boolean readOnly)
void	setSkin(java.lang.String skin)
void	setTabindex(java.lang.String tabindex)
void	setTheme(java.lang.String theme)
void	setToolbar(java.lang.String toolbar)
void	setWidgetVar(java.lang.String widgetVar)
void	setWidth(java.lang.String width)

Methods inherited from class javax.faces.component.html.HtmlInputTextarea

getAccesskey, getCols, getDir, getLabel, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRows, getStyle, getStyleClass, getTitle, isDisabled, isReadonly, setAccesskey, setCols, setDir, setDisabled, setLabel, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setRows, setStyle, setStyleClass, setTitle

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, 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, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, 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, 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.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

EVENT_SAVE

public static final java.lang.String EVENT_SAVE

See Also:

Constant Field Values

EVENT_INITIALIZE

public static final java.lang.String EVENT_INITIALIZE

See Also:

Constant Field Values

EVENT_BLUR

public static final java.lang.String EVENT_BLUR

See Also:

Constant Field Values

EVENT_FOCUS

public static final java.lang.String EVENT_FOCUS

See Also:

Constant Field Values

EVENT_WYSIWYG_MODE

public static final java.lang.String EVENT_WYSIWYG_MODE

See Also:

Constant Field Values

EVENT_SOURCE_MODE

public static final java.lang.String EVENT_SOURCE_MODE

See Also:

Constant Field Values

EVENT_DIRTY

public static final java.lang.String EVENT_DIRTY

Event, which will be fired after the content has been changed (without blur before).

See Also:

Constant Field Values

EVENT_CHANGE

public static final java.lang.String EVENT_CHANGE

Event, which will be fired after blur, when the content has been changed.

See Also:

Constant Field Values

Constructor Detail

CKEditor

public CKEditor()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.html.HtmlInputTextarea

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.html.HtmlInputTextarea

getHeight

public java.lang.String getHeight()

setHeight

public void setHeight(java.lang.String height)

getWidth

public java.lang.String getWidth()

setWidth

public void setWidth(java.lang.String width)

getTheme

public java.lang.String getTheme()

setTheme

public void setTheme(java.lang.String theme)

getSkin

public java.lang.String getSkin()

setSkin

public void setSkin(java.lang.String skin)

getInterfaceColor

public java.lang.String getInterfaceColor()

setInterfaceColor

public void setInterfaceColor(java.lang.String interfaceColor)

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

getToolbar

public java.lang.String getToolbar()

setToolbar

public void setToolbar(java.lang.String toolbar)

getDefaultLanguage

public java.lang.String getDefaultLanguage()

setDefaultLanguage

public void setDefaultLanguage(java.lang.String defaultLanguage)

getLanguage

public java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String language)

getContentsCss

public java.lang.String getContentsCss()

setContentsCss

public void setContentsCss(java.lang.String contentsCss)

getWidgetVar

public java.lang.String getWidgetVar()

setWidgetVar

public void setWidgetVar(java.lang.String widgetVar)

getCheckDirtyInterval

public int getCheckDirtyInterval()

setCheckDirtyInterval

public void setCheckDirtyInterval(int checkDirtyInterval)

getCustomConfig

public java.lang.String getCustomConfig()

setCustomConfig

public void setCustomConfig(java.lang.String customConfig)

getTabindex

public java.lang.String getTabindex()

Overrides:

getTabindex in class javax.faces.component.html.HtmlInputTextarea

setTabindex

public void setTabindex(java.lang.String tabindex)

Overrides:

setTabindex in class javax.faces.component.html.HtmlInputTextarea

isEscape

public boolean isEscape()

setEscape

public void setEscape(boolean escape)

resolveWidgetVar

public java.lang.String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface org.primefaces.component.api.Widget

setAttribute

public void setAttribute(CKEditor.PropertyKeys property,
                         java.lang.Object value)