psdi.webclient.controls

Class RichTextControl

java.lang.Object

psdi.webclient.system.controller.BaseInstance

psdi.webclient.system.controller.ControlInstance

psdi.webclient.controls.RichTextControl

All Implemented Interfaces:

java.lang.Cloneable, DataBeanListener

Direct Known Subclasses:

LongDescription

public class RichTextControl
extends ControlInstance
implements DataBeanListener

The class for the implementation of the Rich Text Control. This class primarily handles events related to spell checking and graceful degradation when the client does not support rich text editing.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HOLDER_ID_SUFFIX
static java.lang.String	PROP_HOLDER_ID
static java.lang.String	PROP_RENDER_TEXT_AREA A property used when rendering in a mobile application that indicates that a text area should be shown instead of the rich text viewer which is shown if the value for this control contains html.
static java.lang.String	PROP_REPLACEMENT_METHOD

Fields inherited from class psdi.webclient.system.controller.ControlInstance

amIinitialize, DATASOURCE, INPUTMODE, labelOverride, ONDATACAHNGE, PARAM_APP, PARAM_APPTABTYPE, PARAM_DESIGNMODE, PARAM_LIGHTNING, PARAM_MOBILE, PARAM_MODULE, PARAM_PAGE, PARAM_PARENTCOMPONENT, PARAM_PARENTCONTROL, PARAM_PRESENTATION, PARAM_SCREENREADER, PARAM_SKINNAME, PARAM_TAB, PARAM_TABGROUP, PARAM_TABGROUP_MAIN, PARAM_TABLE, PARAM_USERINFO, PARAM_VERTICALLABEL, RERENDER_PROPERTY

Fields inherited from class psdi.webclient.system.controller.BaseInstance

EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST

Constructor Summary

Constructors

Constructor and Description
RichTextControl()

Method Summary

Modifier and Type	Method and Description
void	dataChangedEvent(DataBean speaker)
BaseInstance	getChildComponent(BaseInstance component, java.lang.String componentType) Gets the child component of the specified type from the base component.
DataBean	getControlBean()
java.lang.String	getCurrentValue()
java.lang.String	getDataAttribute()
void	initialize() Initializes this control.
boolean	isRichTextSupported() Determines if the rich text editing is supported on this device.
int	render() Renders the RichTextControl.
int	spellcheck() Forwards request to spellcheck_dialog
int	spellcheckreturn() Registered call-back method for spell check dialog
void	structureChangedEvent(DataBean speaker)

Methods inherited from class psdi.webclient.system.controller.ControlInstance

addChild, addComponent, broadcastEvent, canInsert, canInsert, canRemove, childHasError, childHasErrorFocus, cleanup, clearComponent, clearErrors, copy, createRenderId, errorLevelChanged, eventCheck, findComponentByDescriptorId, findDesignerProperty, findProperty, findUseForLablledByComponent, getAdaptorInstance, getBoundComponent, getComponent, getComponents, getConditonallyChanged, getDataBean, getDataSource, getDescriptorControl, getDesignerProperty, getDesignerSelected, getDesignerSelectedControl, getElement, getErrorLevel, getGeneratedControl, getOriginalControl, getOriginalProperty, getProperties, getProperty, getProperty, getPropertyIgnoreFlags, getPropertyOriginator, getPropertyUncle, getRecordHover, getSkipPreRender, getTableControl, getTakesValueComponent, handleEvent, hasChanged, hasChangedConditionally, hasChildElements, hasMaskedChanged, hasRecordHover, hasVisibleChildren, instantiatedatasrc, isDesignerEditedProperty, isDisabled, isFocusable, isGenerated, isHiddenByLicense, isIncluded, isLastChild, isMainrecActionMenu, isMasked, isOnTableFilterRow, isOnTableTitleRow, isPersistentProperty, isReInitialize, isSelected, isToBeDisplayedOnCurrentTab, isToBeDisplayedOnTab, isVisible, launchexternal, moveChild, needsRender, parseParamvalues, preRender, preRenderChecks, quickinsert, registerDesignerEditedProperty, reInitialize, removeChild, renderChildren, resetDataSource, resolveParam, resolveParams, setAttributeError, setBoundComponent, setChangedFlag, setChangedFlag, setDesignerSelected, setDisabled, setElement, setErrorFocusOnControl, setFocus, setFocus, setFocusable, setFocusTable, setGenerated, setGeneratedControl, setIncluded, setIncluded, setNeedsRender, setOnTableFilterRow, setOnTableRow, setOnTableTitleRow, setOriginalControl, setPropertyOriginator, setPropertyUncle, setReInitialize, setReRenderFlags, setSelected, setSkipPreRender, setTableControl, setVisibility, stopRender, walkForId, walkForId

Methods inherited from class psdi.webclient.system.controller.BaseInstance

addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getId, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRenderId, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, hasAnyPropertyChanged, hasLocalProperty, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, isOnTableRow, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROP_RENDER_TEXT_AREA

public static final java.lang.String PROP_RENDER_TEXT_AREA

A property used when rendering in a mobile application that indicates that a text area should be shown instead of the rich text viewer which is shown if the value for this control contains html.

See Also:

Constant Field Values

PROP_HOLDER_ID

public static final java.lang.String PROP_HOLDER_ID

See Also:

Constant Field Values

PROP_REPLACEMENT_METHOD

public static final java.lang.String PROP_REPLACEMENT_METHOD

See Also:

Constant Field Values

HOLDER_ID_SUFFIX

public static final java.lang.String HOLDER_ID_SUFFIX

See Also:

Constant Field Values

Constructor Detail

RichTextControl

public RichTextControl()

Method Detail

initialize

public void initialize()

Initializes this control. If the client does not support rich text, the appropriate viewer is selected.

Overrides:

initialize in class ControlInstance

spellcheck

public int spellcheck()
               throws MXException

Forwards request to spellcheck_dialog

Returns:

WebClientBean.EVENT_HANDLED

Throws:

MXException

getCurrentValue

public java.lang.String getCurrentValue()

spellcheckreturn

public int spellcheckreturn()
                     throws MXException

Registered call-back method for spell check dialog

Returns:

Throws:

MXException

getDataAttribute

public java.lang.String getDataAttribute()

getControlBean

public DataBean getControlBean()

isRichTextSupported

public boolean isRichTextSupported()

Determines if the rich text editing is supported on this device. Currently mobile browsers do not support rich text editing, but this may change in the future.

Returns:

True if the client browser supports rich text editing.

render

public int render()
           throws java.lang.reflect.InvocationTargetException,
                  java.lang.IllegalAccessException,
                  java.lang.NoSuchMethodException

Renders the RichTextControl. If rich text is not supported, the control is prepared to render either the rich text viewer or text area instead. This is currently only true for mobile devices although it could change in the future.

Overrides:

render in class ControlInstance

Throws:

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

java.lang.NoSuchMethodException

dataChangedEvent

public void dataChangedEvent(DataBean speaker)

Specified by:

dataChangedEvent in interface DataBeanListener

structureChangedEvent

public void structureChangedEvent(DataBean speaker)

Specified by:

structureChangedEvent in interface DataBeanListener

getChildComponent

public BaseInstance getChildComponent(BaseInstance component,
                                      java.lang.String componentType)

Gets the child component of the specified type from the base component. This method calls recursively down the component tree to find the component. The first component instance found of the specified type is returned.

Parameters:

component - The component instance. If it is of the specified type, it is returned.

componentType - The component type to search for.

Returns:

The ComponentInstance found. Null is no instance could be found.