|
RichFaces UI Components UI 4.3.1.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.richfaces.component.AbstractEditor
org.richfaces.component.UIEditor
@Generated(value={"RichFaces CDK","4.3.1.Final"}) public class UIEditor
The <rich:editor> component is used for creating a WYSIWYG editor on a page.
Nested Class Summary | |
---|---|
protected static class |
UIEditor.Properties
|
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
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 | |
---|---|
UIEditor()
|
Method Summary | |
---|---|
javax.faces.component.UIComponent |
getConfig()
Detailed configuration of editor in JSON format |
String |
getDefaultEventName()
|
Collection<String> |
getEventNames()
|
String |
getFamily()
|
String |
getHeight()
The hieght of the editor |
String |
getLang()
Code describing the language used in the generated markup for this component. |
String |
getOnblur()
The client-side script method to be called when the editor loses focus |
String |
getOnchange()
The client-side script method to be called on blur event when editor content has been changed after previous focus |
String |
getOndirty()
The client-side script method to be called immediately after the editor content has been changed |
String |
getOnfocus()
The client-side script method to be called when the editor receives focus |
String |
getOninit()
The client-side script method to be called once the editor is initialized and ready to be handle user interaction |
String |
getSkin()
Set the skin of the richfaces editor. |
String |
getStyle()
|
String |
getStyleClass()
|
String |
getTitle()
|
String |
getToolbar()
Used to change the configuration of the toolbar's button set. |
String |
getWidth()
The width of the editor |
boolean |
isReadonly()
Used to switch the editor into a read-only mode. |
void |
setConfig(javax.faces.component.UIComponent config)
|
void |
setHeight(String height)
|
void |
setLang(String lang)
|
void |
setOnblur(String onblur)
|
void |
setOnchange(String onchange)
|
void |
setOndirty(String ondirty)
|
void |
setOnfocus(String onfocus)
|
void |
setOninit(String oninit)
|
void |
setReadonly(boolean readonly)
|
void |
setSkin(String skin)
|
void |
setStyle(String style)
|
void |
setStyleClass(String styleClass)
|
void |
setTitle(String title)
|
void |
setToolbar(String toolbar)
|
void |
setWidth(String width)
|
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 |
---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
Constructor Detail |
---|
public UIEditor()
Method Detail |
---|
public String getFamily()
getFamily
in class javax.faces.component.UIInput
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public javax.faces.component.UIComponent getConfig()
AbstractEditor
getConfig
in class AbstractEditor
public void setConfig(javax.faces.component.UIComponent config)
public String getHeight()
AbstractEditor
getHeight
in class AbstractEditor
public void setHeight(String height)
public String getLang()
AbstractEditor
getLang
in class AbstractEditor
public void setLang(String lang)
public String getOnblur()
AbstractEditor
getOnblur
in class AbstractEditor
public void setOnblur(String onblur)
public String getOnchange()
AbstractEditor
getOnchange
in class AbstractEditor
public void setOnchange(String onchange)
public String getOndirty()
AbstractEditor
getOndirty
in class AbstractEditor
public void setOndirty(String ondirty)
public String getOnfocus()
AbstractEditor
getOnfocus
in class AbstractEditor
public void setOnfocus(String onfocus)
public String getOninit()
AbstractEditor
getOninit
in class AbstractEditor
public void setOninit(String oninit)
public boolean isReadonly()
AbstractEditor
isReadonly
in class AbstractEditor
public void setReadonly(boolean readonly)
public String getSkin()
AbstractEditor
Set the skin of the richfaces editor. Bundled skins include: richfaces, kama, v2, office2003
Default is richfaces
getSkin
in class AbstractEditor
public void setSkin(String skin)
public String getStyle()
public void setStyle(String style)
public String getStyleClass()
public void setStyleClass(String styleClass)
public String getTitle()
public void setTitle(String title)
public String getToolbar()
AbstractEditor
Used to change the configuration of the toolbar's button set. There are two configurations available: basic (default), full (enables all of the features).
It is also possible to define a custom toolbar using the CKEditor toolbar configuration in a config facet
Default is basic
getToolbar
in class AbstractEditor
public void setToolbar(String toolbar)
public String getWidth()
AbstractEditor
getWidth
in class AbstractEditor
public void setWidth(String width)
|
RichFaces UI Components UI 4.3.1.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |