com.ibm.xsp.component
Class UIInputRichText

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  com.ibm.xsp.component.UIInputEx
                      com.ibm.xsp.component.UIInputRichText

All Implemented Interfaces:

FacesAjaxComponent, FacesAttrsObject, FacesComponent, FacesInputComponent, FacesInputFiltering, FacesOutputFiltering, FacesDojoComponent, ThemeControl, javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

XspInputRichText

public class UIInputRichText
extends UIInputEx
implements ThemeControl, FacesAjaxComponent, FacesAttrsObject

Not intended to be subclassed.

Nested Class Summary

static class

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	_HIDDENINPUT
static java.lang.String	_ISMODIFIED_INPUT
static java.lang.String	_READONLYINPUT
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	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

UIInputRichText()

Method Summary

void	addAttr(Attr attr) Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
java.util.List<Attr>	getAttrs() The extra attributes to be output on the base element at the root of this control or object tag.
java.lang.String	getDefaultHtmlFilter() The name of the html filtering engine to use when the "htmlFilter" property is not set in the XPage source.
java.lang.String	getDefaultHtmlFilterIn() The name of the html filtering engine to use when the "htmlFilterIn" property is not set in the XPage source.
java.lang.String	getFamily()
java.lang.String	getHtmlConversionWarning()
java.lang.String	getStyleKitFamily() The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
IMimeMultipart	getValueAsMime(java.lang.String value)
java.lang.String	getValueHolderClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
java.lang.String	getValueHolderIsModifiedClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
java.lang.String	getValueHolderReadOnlyClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
boolean	handles(javax.faces.context.FacesContext context) Check if the pathinfo request is for this target ajax component
void	processAjaxRequest(javax.faces.context.FacesContext context) Process the request for this target ajax component
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAttrs(java.util.List<Attr> attrs) This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
void	setHtmlConversionWarning(java.lang.String htmlConversionWarning)
void	setParent(javax.faces.component.UIComponent parent)

Methods inherited from class com.ibm.xsp.component.UIInputEx

addDojoAttribute, buildContents, getConvertedValue, getDefaultValue, getDojoAttributes, getDojoType, getHtmlFilter, getHtmlFilterIn, getHtmlFilterInName, getHtmlFilterName, getMultipleSeparator, getRendererComponent, getRequiredMessage, getValue, getValueAsList, getValueAsString, initAfterContents, initBeforeContents, isDisableClientSideValidation, isDisableModifiedFlag, isDisableValidators, isMultipleTrim, isRequired, isShowReadonlyAsDisabled, setDefaultValue, setDisableClientSideValidation, setDisableModifiedFlag, setDisableValidators, setDojoAttributes, setDojoType, setMultipleSeparator, setMultipleTrim, setRendererComponent, setRequired, setShowReadonlyAsDisabled, setValueFromString, updateModel, validateItemValue, 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

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

_HIDDENINPUT

public static final java.lang.String _HIDDENINPUT

See Also:

Constant Field Values

_READONLYINPUT

public static final java.lang.String _READONLYINPUT

See Also:

Constant Field Values

_ISMODIFIED_INPUT

public static final java.lang.String _ISMODIFIED_INPUT

See Also:

Constant Field Values

Constructor Detail

UIInputRichText

public UIInputRichText()

Method Detail

getDefaultHtmlFilter

public java.lang.String getDefaultHtmlFilter()

Description copied from class: UIInputEx

The name of the html filtering engine to use when the "htmlFilter" property is not set in the XPage source. This UIInputEx implementation defaults to null, but subclasses may provide a default filter for their control type.

Overrides:

getDefaultHtmlFilter in class UIInputEx

Returns:

null or the name of the default output filter to use when the "htmlFilter" property is not set in the XPage source.

See Also:

FacesOutputFiltering.getHtmlFilterName()

getDefaultHtmlFilterIn

public java.lang.String getDefaultHtmlFilterIn()

Description copied from class: UIInputEx

The name of the html filtering engine to use when the "htmlFilterIn" property is not set in the XPage source. This UIInputEx implementation defaults to null, but subclasses may provide a default filter for their control type.

Overrides:

getDefaultHtmlFilterIn in class UIInputEx

Returns:

null or the name of the default input filter to use when the "htmlFilterIn" property is not set in the XPage source.

See Also:

FacesInputFiltering.getHtmlFilterInName()

setParent

public void setParent(javax.faces.component.UIComponent parent)

Overrides:

setParent in class javax.faces.component.UIComponentBase

getHtmlConversionWarning

public java.lang.String getHtmlConversionWarning()

setHtmlConversionWarning

public void setHtmlConversionWarning(java.lang.String htmlConversionWarning)

getAttrs

public java.util.List<Attr> getAttrs()

The extra attributes to be output on the base element at the root of this control or object tag. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addAttr(Attr) method should be used to add an Attr.

Specified by:

getAttrs in interface FacesAttrsObject

addAttr

public void addAttr(Attr attr)

Add an Attr, to appear as an attribute in the HTML output of this control or object tag.

Specified by:

addAttr in interface FacesAttrsObject

Parameters:

action -

setAttrs

public void setAttrs(java.util.List<Attr> attrs)

This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getStyleKitFamily

public java.lang.String getStyleKitFamily()

Description copied from interface: ThemeControl

The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:

getStyleKitFamily in interface ThemeControl

Overrides:

getStyleKitFamily in class UIInputEx

Returns:

a non-null themeId corresponding to the configuration for this type of control in a theme file.

See Also:

ThemeControl.getStyleKitFamily()

getValueHolderClientId

public java.lang.String getValueHolderClientId(javax.faces.context.FacesContext context,
                                               javax.faces.component.UIComponent component)

getValueHolderReadOnlyClientId

public java.lang.String getValueHolderReadOnlyClientId(javax.faces.context.FacesContext context,
                                                       javax.faces.component.UIComponent component)

getValueHolderIsModifiedClientId

public java.lang.String getValueHolderIsModifiedClientId(javax.faces.context.FacesContext context,
                                                         javax.faces.component.UIComponent component)

getValueAsMime

public IMimeMultipart getValueAsMime(java.lang.String value)

handles

public boolean handles(javax.faces.context.FacesContext context)

Description copied from interface: FacesAjaxComponent

Check if the pathinfo request is for this target ajax component

Specified by:

handles in interface FacesAjaxComponent

Returns:

true if request handler

processAjaxRequest

public void processAjaxRequest(javax.faces.context.FacesContext context)
                        throws java.io.IOException

Description copied from interface: FacesAjaxComponent

Process the request for this target ajax component

Specified by:

processAjaxRequest in interface FacesAjaxComponent

Throws:

java.io.IOException

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIInputEx

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 UIInputEx