com.ibm.xsp.component.xp
Class XspInputRichText

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by com.ibm.xsp.component.UIInputEx
                      extended by com.ibm.xsp.component.UIInputRichText
                          extended by com.ibm.xsp.component.xp.XspInputRichText
All Implemented Interfaces:
FacesAjaxComponent, FacesComponent, FacesInputComponent, FacesInputFiltering, FacesOutputFiltering, FacesDojoComponent, ThemeControl, javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class XspInputRichText
extends UIInputRichText

A control that displays a field for entering multiple lines of rich text.

XPages Core Controls - Rich Text

Represents an instance of the CKEditor Rich Text Editor


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.xsp.component.UIInputRichText
UIInputRichText.EmbeddedImage
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponent
javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry
 
Field Summary
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class com.ibm.xsp.component.UIInputRichText
_HIDDENINPUT, _ISMODIFIED_INPUT, _READONLYINPUT, COMPONENT_FAMILY, RENDERER_TYPE
 
Fields inherited from class javax.faces.component.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIComponentBase
EMPTY_ITERATOR
 
Fields inherited from class javax.faces.component.UIComponent
_xspStateId
 
Constructor Summary
XspInputRichText()
           
 
Method Summary
 java.lang.String getAccesskey()
           Return the value of the accesskey property.
 java.lang.String getDir()
           Return the value of the dir property.
 java.lang.String getDojoUsage()
           Return the value of the dojoUsage property.
 java.lang.String getHtmlFilter()
           Return the value of the htmlFilter property.
 java.lang.String getHtmlFilterIn()
           Return the value of the htmlFilterIn property.
 java.lang.String getLang()
           Return the value of the lang property.
 java.lang.String getOnblur()
           Return the value of the onblur property.
 java.lang.String getOnchange()
           Return the value of the onchange property.
 java.lang.String getOnclick()
           Return the value of the onclick property.
 java.lang.String getOnfocus()
           Return the value of the onfocus property.
 java.lang.String getOnkeydown()
           Return the value of the onkeydown property.
 java.lang.String getOnkeypress()
           Return the value of the onkeypress property.
 java.lang.String getOnkeyup()
           Return the value of the onkeyup property.
 java.lang.String getOuterStyleClass()
           Return the value of the outerStyleClass property.
 java.lang.String getRole()
           Return the value of the role property.
 java.lang.String getStyle()
           Return the value of the style property.
 java.lang.String getStyleClass()
           Return the value of the styleClass property.
 java.lang.String getTabindex()
           Return the value of the tabindex property.
 java.lang.String getTitle()
           Return the value of the title property.
 boolean isDisabled()
           Return the value of the disabled property.
 boolean isReadonly()
           Return the value of the readonly property.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
           
 void setAccesskey(java.lang.String accesskey)
           Set the value of the accesskey property.
 void setDir(java.lang.String dir)
           Set the value of the dir property.
 void setDisabled(boolean disabled)
           Set the value of the disabled property.
 void setDojoUsage(java.lang.String dojoUsage)
           Set the value of the dojoUsage property.
 void setHtmlFilter(java.lang.String htmlFilter)
           Set the value of the htmlFilter property.
 void setHtmlFilterIn(java.lang.String htmlFilterIn)
           Set the value of the htmlFilterIn property.
 void setLang(java.lang.String lang)
           Set the value of the lang property.
 void setOnblur(java.lang.String onblur)
           Set the value of the onblur property.
 void setOnchange(java.lang.String onchange)
           Set the value of the onchange property.
 void setOnclick(java.lang.String onclick)
           Set the value of the onclick property.
 void setOnfocus(java.lang.String onfocus)
           Set the value of the onfocus property.
 void setOnkeydown(java.lang.String onkeydown)
           Set the value of the onkeydown property.
 void setOnkeypress(java.lang.String onkeypress)
           Set the value of the onkeypress property.
 void setOnkeyup(java.lang.String onkeyup)
           Set the value of the onkeyup property.
 void setOuterStyleClass(java.lang.String outerStyleClass)
           Set the value of the outerStyleClass property.
 void setReadonly(boolean readonly)
           Set the value of the readonly property.
 void setRole(java.lang.String role)
           Set the value of the role property.
 void setStyle(java.lang.String style)
           Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
           Set the value of the styleClass property.
 void setTabindex(java.lang.String tabindex)
           Set the value of the tabindex property.
 void setTitle(java.lang.String title)
           Set the value of the title property.
 
Methods inherited from class com.ibm.xsp.component.UIInputRichText
getDefaultHtmlFilter, getDefaultHtmlFilterIn, getFamily, getHtmlConversionWarning, getStyleKitFamily, getValueAsMime, getValueHolderClientId, getValueHolderIsModifiedClientId, getValueHolderReadOnlyClientId, handles, processAjaxRequest, setHtmlConversionWarning, setParent
 
Methods inherited from class com.ibm.xsp.component.UIInputEx
addDojoAttribute, buildContents, getConvertedValue, getDefaultValue, getDojoAttributes, getDojoType, getHtmlFilterInName, getHtmlFilterName, getMultipleSeparator, getRendererComponent, getRequiredMessage, getValue, getValueAsList, getValueAsString, initAfterContents, initBeforeContents, isDisableClientSideValidation, isDisableModifiedFlag, isDisableValidators, isMultipleTrim, isRequired, setDefaultValue, setDisableClientSideValidation, setDisableModifiedFlag, setDisableValidators, setDojoAttributes, setDojoType, setMultipleSeparator, setMultipleTrim, setRendererComponent, setRequired, setValueFromString, updateModel, validateValue
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, compareValues, decode, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, validate
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, 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 java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

XspInputRichText

public XspInputRichText()
Method Detail

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property. Contents:

Transfers focus to the control when pressed


getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).


getDojoUsage

public java.lang.String getDojoUsage()

Return the value of the dojoUsage property. Contents:

This property is obsolete, configure the "Dojo Type" property instead. This used to determine whether the control would use Dojo.

XPages Basics Property Category - Dojo Usage


getHtmlFilter

public java.lang.String getHtmlFilter()

Return the value of the htmlFilter property. Contents:

Indicates which Active Content Filtering processor to use.

Overrides:
getHtmlFilter in class UIInputEx

getHtmlFilterIn

public java.lang.String getHtmlFilterIn()

Return the value of the htmlFilterIn property. Contents:

Indicates which Active Content Filtering processor should be used when data is uploaded.

Overrides:
getHtmlFilterIn in class UIInputEx

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.


getOnblur

public java.lang.String getOnblur()

Return the value of the onblur property. Contents:

JavaScript code executed when this control loses focus


getOnchange

public java.lang.String getOnchange()

Return the value of the onchange property. Contents:

JavaScript code executed when this control loses focus and its value has been modified since gaining focus


getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer control is clicked over this control


getOnfocus

public java.lang.String getOnfocus()

Return the value of the onfocus property. Contents:

JavaScript code executed when this control receives focus


getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property. Contents:

JavaScript code executed when a key is pressed down over this control


getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property. Contents:

JavaScript code executed when a key is pressed and released over this control.


getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property. Contents:

JavaScript code executed when a key is released over this control


getOuterStyleClass

public java.lang.String getOuterStyleClass()

Return the value of the outerStyleClass property. Contents:

Space-separated list of CSS style class(es) to be applied when this control is rendered. When this value is set, the renderer generates an enclosing span using this style as the "class" attribute on generated markup.


getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.


getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

%/com.ibm.xsp.group.core/style/descr%


getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.


getTabindex

public java.lang.String getTabindex()

Return the value of the tabindex property. Contents:

Indicates where this control is located in the tab order of the page. Value must be an integer between 0 and 32,767. If the value is left blank, the tab order will inherit the browser's default order.


getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.


isDisabled

public boolean isDisabled()

Return the value of the disabled property. Contents:

Determines whether or not the page can receive focus or be included in page submissions.


isReadonly

public boolean isReadonly()

Return the value of the readonly property. Contents:

Flag indicating that this control will prohibit changes by the user. The control may receive focus unless it has also been disabled.


restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class UIInputRichText

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class UIInputRichText

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.


setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.


setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.


setDojoUsage

public void setDojoUsage(java.lang.String dojoUsage)

Set the value of the dojoUsage property.


setHtmlFilter

public void setHtmlFilter(java.lang.String htmlFilter)

Set the value of the htmlFilter property.


setHtmlFilterIn

public void setHtmlFilterIn(java.lang.String htmlFilterIn)

Set the value of the htmlFilterIn property.


setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.


setOnblur

public void setOnblur(java.lang.String onblur)

Set the value of the onblur property.


setOnchange

public void setOnchange(java.lang.String onchange)

Set the value of the onchange property.


setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.


setOnfocus

public void setOnfocus(java.lang.String onfocus)

Set the value of the onfocus property.


setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.


setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.


setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.


setOuterStyleClass

public void setOuterStyleClass(java.lang.String outerStyleClass)

Set the value of the outerStyleClass property.


setReadonly

public void setReadonly(boolean readonly)

Set the value of the readonly property.


setRole

public void setRole(java.lang.String role)

Set the value of the role property.


setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.


setTabindex

public void setTabindex(java.lang.String tabindex)

Set the value of the tabindex property.


setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.