Skip navigation links

oracle.adf.view.rich.component.rich.input
Class PartialRichTextEditor

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXValue
org.apache.myfaces.trinidad.component.UIXEditableValue
org.apache.myfaces.trinidad.component.UIXInput
oracle.adf.view.rich.component.rich.input.PartialRichTextEditor

All Implemented Interfaces:

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

Direct Known Subclasses:

RichTextEditor

public abstract class PartialRichTextEditor

extends org.apache.myfaces.trinidad.component.UIXInput

implements javax.faces.component.behavior.ClientBehaviorHolder

The richTextEditor component creates an input widget for rich text formatting. It also supports displaying a label, text, and messages.

<section name="Supported_Features">

The supported features are:

• Font Name
• Font Size
• Link
• Unlink
• Clear Styling
• Undo
• Redo
• Bold
• Italics
• Underline
• Subscript
• Superscript
• Justify (Left, Middle, Right, Full)
• Ordered Lists
• Unordered Lists
• Indentation
• Text color
• Background color

</section> <section name="Format_of_the_value">

The value is a well-formed XHTML-fragment. Due to browser limitations, the value may be altered. If there are tags or styles that are not editable in a particular browser, we transform the tags/styles into something that the specific browser can edit. Also, for security reasons, some features such as script-related tags and attributes will be removed.

There are no guarantees that this component only records the minimal changes made by the user. As a result of editing an XHTML document, this component might change:

• non-meaningful whitespace
• element minimization
• element types
• order of attributes
• use of character entities

Only html 4 tags are supported, with the exception of those listed below

• script, noscript
• frame, frameset, noframes
• "form" related elements - input, select, optgroup, option, textarea, form, button, label, isindex
• "document" related elements - html, head, body, meta, title, base, link

Also not supported

• embed (not supported in html 4)
• unknown tags, for example <foo>

We do support tags that pull in content such as applet, iframe, object, img, and a. For iframe in particular the browsers only allow interactions with content from the same domain, so the content in these should not be able to interact with the rest of the page. However be aware that this portion of the page is not under the control of the application. For example the content of an iframe may have content asking for a password.

</section> <section name="Limitations">

"Font Size" only works with the font sizes 1-7 as described in the HTML specification for the <font>-element. There is no support for other units such as px or em.

On the client, there is no support for getValue / setValue. We can not guarantee that the value is the same as the value on the server (see Format of the value). Due to this, there is also no support for client-side converters and validators. Server-side converters and validators will still work as usual.

</section> <section name="Width">

To make the rich text editor component's width 100%, set simple to true, inlineStyle to "width: 100%" and contentStyle to "width: 100%" too.

<af:richTextEditor simple="true" inlineStyle="width: 100%;" contentStyle="width: 100%;"/>

Note: This only works reliably when contained in geometry-managing parents; if placed in a flowing layout container such as a panelFormLayout or a panelGroupLayout, 100% widths may not work reliably.

</section> <section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component.</html:li> <html:li>This component does not display any children so there are no child stretching capabilities.</html:li> </html:ul> </section>

Events:

Type	Phases	Description
javax.faces.event.ValueChangeEvent	Process Validations Apply Request Values	The valueChange event is delivered when the value attribute is changed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ACCESS_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AUTO_SUBMIT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CHANGED_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CHANGED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLUMNS_KEY
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	CONTENT_DELIVERY_IMMEDIATE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_DELIVERY_KEY
static String	CONTENT_DELIVERY_LAZY
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	DISABLED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EDIT_MODE_KEY
static String	EDIT_MODE_SOURCE
static String	EDIT_MODE_WYSIWYG
static String	HELP_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	HELP_TOPIC_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	READ_ONLY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROWS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_REQUIRED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SIMPLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TOOLBOX_LAYOUT_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue

CONVERSION_MESSAGE_ID, IMMEDIATE_KEY, LOCAL_VALUE_SET_KEY, REQUIRED_KEY, REQUIRED_MESSAGE_DETAIL_KEY, REQUIRED_MESSAGE_ID, SUBMITTED_VALUE_KEY, TRINIDAD_BEAN_VALIDATION_AVAILABLE, TRINIDAD_EMPTY_VALUES_AS_NULL_PARAM_NAME, VALID_KEY, VALIDATE_EMPTY_FIELDS_PARAM_NAME, VALIDATOR_KEY, VALIDATORS_KEY, VALUE_CHANGE_LISTENER_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXValue

CONVERTER_KEY, VALUE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

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

protected

PartialRichTextEditor(String rendererType) Construct an instance of the PartialRichTextEditor.

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
char	getAccessKey() Gets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element).
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
String	getChangedDesc() Gets the text commonly used by user agents to display tooltip text on the changed indicator icon.
Set	getClientAttributes() Gets a set of client attribute names.
Map<String,List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
ClientListenerSet	getClientListeners() Gets a set of client listeners.
int	getColumns() Gets the width of the text control specified by the approximate number of characters shown.
String	getContentDelivery() Gets whether content should be fetched when the component is rendered initially.
String	getContentStyle() Gets the style of the content piece of the component.
String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
String	getDefaultEventName()
String[]	getDontPersist() Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
String	getEditMode() Gets the initial editing mode.
Collection<String>	getEventNames()
String	getFamily()
javax.faces.component.UIComponent	getHelp() This facet is deprecated, helpTopicId should be used for providing help.
String	getHelpTopicId() Gets the id used to look up a topic in a helpProvider.
String	getInlineStyle() Gets the CSS styles to use for this component.
String	getLabel() Gets the label of the component.
String	getLabelStyle() Gets the CSS styles to use for the label of this component.
String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
String[]	getPersist() Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
int	getRows() Gets the height of the text control specified by the approximate number of characters shown.
String	getShortDesc() Gets the short description of the component.
String	getStyleClass() Gets a CSS style class to use for this component.
String[]	getToolboxLayout() Gets Allows control over the layout of the toolbar.
Set<String>	getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
boolean	isAutoSubmit() Gets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.).
boolean	isChanged() Gets an attribute which if set to true, the changed indicator icon will be displayed on the component.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isDisabled() Gets whether the element is disabled.
boolean	isReadOnly() Gets whether the control is displayed as an editable field or as an output-style text control.
boolean	isShowRequired() Gets whether the associated control displays a visual indication of required user input.
boolean	isSimple() Gets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives.
boolean	isVisible() Gets the visibility of the component.
void	setAccessKey(char accessKey) Sets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element).
void	setAutoSubmit(boolean autoSubmit) Sets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.).
void	setChanged(boolean changed) Sets an attribute which if set to true, the changed indicator icon will be displayed on the component.
void	setChangedDesc(String changedDesc) Sets the text commonly used by user agents to display tooltip text on the changed indicator icon.
void	setClientAttributes(Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setColumns(int columns) Sets the width of the text control specified by the approximate number of characters shown.
void	setContentDelivery(String contentDelivery) Sets whether content should be fetched when the component is rendered initially.
void	setContentStyle(String contentStyle) Sets the style of the content piece of the component.
void	setCustomizationId(String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDisabled(boolean disabled) Sets whether the element is disabled.
void	setDontPersist(String[] dontPersist) Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
void	setEditMode(String editMode) Sets the initial editing mode.
void	setHelp(javax.faces.component.UIComponent helpFacet) This facet is deprecated, helpTopicId should be used for providing help.
void	setHelpTopicId(String helpTopicId) Sets the id used to look up a topic in a helpProvider.
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setLabel(String label) Sets the label of the component.
void	setLabelStyle(String labelStyle) Sets the CSS styles to use for the label of this component.
void	setPartialTriggers(String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setPersist(String[] persist) Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
void	setReadOnly(boolean readOnly) Sets whether the control is displayed as an editable field or as an output-style text control.
void	setRows(int rows) Sets the height of the text control specified by the approximate number of characters shown.
void	setShortDesc(String shortDesc) Sets the short description of the component.
void	setShowRequired(boolean showRequired) Sets whether the associated control displays a visual indication of required user input.
void	setSimple(boolean simple) Sets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives.
void	setStyleClass(String styleClass) Sets a CSS style class to use for this component.
void	setToolboxLayout(String[] toolboxLayout) Sets Allows control over the layout of the toolbar.
void	setUnsecure(Set<String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
void	setVisible(boolean visible) Sets the visibility of the component.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue

addValidator, addValueChangeListener, broadcast, compareValues, getConvertedValue, getRequiredMessageDetail, getRequiredMessageKey, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, shouldInterpretEmptyStringSubmittedValuesAsNull, shouldValidateEmptyFields, updateModel, validate, validateValue

Methods inherited from class org.apache.myfaces.trinidad.component.UIXValue

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter, setValue

Field Detail

EDIT_MODE_WYSIWYG

public static final String EDIT_MODE_WYSIWYG

See Also:

Constant Field Values

EDIT_MODE_SOURCE

public static final String EDIT_MODE_SOURCE

See Also:

Constant Field Values

CONTENT_DELIVERY_IMMEDIATE

public static final String CONTENT_DELIVERY_IMMEDIATE

See Also:

Constant Field Values

CONTENT_DELIVERY_LAZY

public static final String CONTENT_DELIVERY_LAZY

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

CHANGED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY

CHANGED_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_DESC_KEY

AUTO_SUBMIT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTO_SUBMIT_KEY

ACCESS_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY

CONTENT_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY

HELP_TOPIC_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY

DISABLED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY

LABEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY

LABEL_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_STYLE_KEY

READ_ONLY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey READ_ONLY_KEY

SHOW_REQUIRED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REQUIRED_KEY

SIMPLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SIMPLE_KEY

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

PERSIST_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY

DONT_PERSIST_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY

COLUMNS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMNS_KEY

EDIT_MODE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EDIT_MODE_KEY

ROWS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROWS_KEY

CONTENT_DELIVERY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY

TOOLBOX_LAYOUT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TOOLBOX_LAYOUT_KEY

HELP_FACET

public static final String HELP_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PartialRichTextEditor

protected PartialRichTextEditor(String rendererType)

Construct an instance of the PartialRichTextEditor.

Method Detail

getHelp

public final javax.faces.component.UIComponent getHelp()

This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.

setHelp

public final void setHelp(javax.faces.component.UIComponent helpFacet)

This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.

isChanged

public final boolean isChanged()

Gets an attribute which if set to true, the changed indicator icon will be displayed on the component.

Returns:

the new changed value

setChanged

public final void setChanged(boolean changed)

Sets an attribute which if set to true, the changed indicator icon will be displayed on the component.

Parameters:

changed - the new changed value

getChangedDesc

public final String getChangedDesc()

Gets the text commonly used by user agents to display tooltip text on the changed indicator icon. Default value is "Changed". The behavior of the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.

Returns:

the new changedDesc value

setChangedDesc

public final void setChangedDesc(String changedDesc)

Sets the text commonly used by user agents to display tooltip text on the changed indicator icon. Default value is "Changed". The behavior of the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.

Parameters:

changedDesc - the new changedDesc value

isAutoSubmit

public final boolean isAutoSubmit()

Gets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.

Returns:

the new autoSubmit value

setAutoSubmit

public final void setAutoSubmit(boolean autoSubmit)

Sets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.

Parameters:

autoSubmit - the new autoSubmit value

getAccessKey

public final char getAccessKey()

Gets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.

Returns:

the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)

Sets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.

Parameters:

accessKey - the new accessKey value

getContentStyle

public final String getContentStyle()

Gets the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute.

Returns:

the new contentStyle value

setContentStyle

public final void setContentStyle(String contentStyle)

Sets the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute.

Parameters:

contentStyle - the new contentStyle value

getHelpTopicId

public final String getHelpTopicId()

Gets the id used to look up a topic in a helpProvider.

Returns:

the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(String helpTopicId)

Sets the id used to look up a topic in a helpProvider.

Parameters:

helpTopicId - the new helpTopicId value

isDisabled

public final boolean isDisabled()

Gets whether the element is disabled. Unlike a readonly component, a disabled component is unable to receive focus. If the component has the potential to have a scrollbar, and you want the user to be able to scroll through the component's text or values, use the 'readOnly' attribute, not the 'disabled' attribute.

Returns:

the new disabled value

setDisabled

public final void setDisabled(boolean disabled)

Sets whether the element is disabled. Unlike a readonly component, a disabled component is unable to receive focus. If the component has the potential to have a scrollbar, and you want the user to be able to scroll through the component's text or values, use the 'readOnly' attribute, not the 'disabled' attribute.

Parameters:

disabled - the new disabled value

getLabel

public final String getLabel()

Gets the label of the component. If you want the label to appear above the control, use a panelFormLayout.

Returns:

the new label value

setLabel

public final void setLabel(String label)

Sets the label of the component. If you want the label to appear above the control, use a panelFormLayout.

Parameters:

label - the new label value

getLabelStyle

public final String getLabelStyle()

Gets the CSS styles to use for the label of this component. The labelStyle is a set of CSS styles that are applied to the label DOM element of the component. This allows a label to be styled without requiring a new skin definition.

Returns:

the new labelStyle value

setLabelStyle

public final void setLabelStyle(String labelStyle)

Sets the CSS styles to use for the label of this component. The labelStyle is a set of CSS styles that are applied to the label DOM element of the component. This allows a label to be styled without requiring a new skin definition.

Parameters:

labelStyle - the new labelStyle value

isReadOnly

public final boolean isReadOnly()

Gets whether the control is displayed as an editable field or as an output-style text control. Unlike a disabled component, a readonly component is able to receive focus.

Returns:

the new readOnly value

setReadOnly

public final void setReadOnly(boolean readOnly)

Sets whether the control is displayed as an editable field or as an output-style text control. Unlike a disabled component, a readonly component is able to receive focus.

Parameters:

readOnly - the new readOnly value

isShowRequired

public final boolean isShowRequired()

Gets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. An example of when it can be desirable to use the showRequired property is if you have a field that is initially empty and is required only if some other field on the page is touched.

Returns:

the new showRequired value

setShowRequired

public final void setShowRequired(boolean showRequired)

Sets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. An example of when it can be desirable to use the showRequired property is if you have a field that is initially empty and is required only if some other field on the page is touched.

Parameters:

showRequired - the new showRequired value

isSimple

public final boolean isSimple()

Gets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.

Returns:

the new simple value

setSimple

public final void setSimple(boolean simple)

Sets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.

Parameters:

simple - the new simple value

getInlineStyle

public final String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final String getShortDesc()

Gets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)

Sets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final Set<String> getUnsecure()

Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(Set<String> unsecure)

Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getPersist

public final String[] getPersist()

Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.

Returns:

the new persist value

setPersist

public final void setPersist(String[] persist)

Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.

Parameters:

persist - the new persist value

getDontPersist

public final String[] getDontPersist()

Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".

Returns:

the new dontPersist value

setDontPersist

public final void setDontPersist(String[] dontPersist)

Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".

Parameters:

dontPersist - the new dontPersist value

getColumns

public final int getColumns()

Gets the width of the text control specified by the approximate number of characters shown.

Returns:

the new columns value

setColumns

public final void setColumns(int columns)

Sets the width of the text control specified by the approximate number of characters shown.

Parameters:

columns - the new columns value

getEditMode

public final String getEditMode()

Gets the initial editing mode. Use "wysiwyg" for the what-you-see-is-what-you-get mode. Use "source" for the source code editing mode. The attribute defaults to "wysiwyg". screenreader, phone and tablet agents do not support this attribute and are always in "source" mode. It is very important to note that source mode is not plain text editing. There are no guarantees that this component only records the minimal changes made by the user. This component might change non-meaningful whitespace (new line characters in the source are not preserved), element minimization, element types, order of attributes, or use of character entities.

Returns:

the new editMode value

setEditMode

public final void setEditMode(String editMode)

Sets the initial editing mode. Use "wysiwyg" for the what-you-see-is-what-you-get mode. Use "source" for the source code editing mode. The attribute defaults to "wysiwyg". screenreader, phone and tablet agents do not support this attribute and are always in "source" mode. It is very important to note that source mode is not plain text editing. There are no guarantees that this component only records the minimal changes made by the user. This component might change non-meaningful whitespace (new line characters in the source are not preserved), element minimization, element types, order of attributes, or use of character entities.

Parameters:

editMode - the new editMode value

getRows

public final int getRows()

Gets the height of the text control specified by the approximate number of characters shown.

Returns:

the new rows value

setRows

public final void setRows(int rows)

Sets the height of the text control specified by the approximate number of characters shown.

Parameters:

rows - the new rows value

getContentDelivery

public final String getContentDelivery()

Gets whether content should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", content will be fetched and delivered to the client during a subsequent request.

Returns:

the new contentDelivery value

setContentDelivery

public final void setContentDelivery(String contentDelivery)

Sets whether content should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", content will be fetched and delivered to the client during a subsequent request.

Parameters:

contentDelivery - the new contentDelivery value

getToolboxLayout

public final String[] getToolboxLayout()

Gets Allows control over the layout of the toolbar.

The built in strings the component recognizes are:

• "all" - all the buttons the richTextEditor provides by default - if "all" is in the list, all other built in strings are ignored
• "font" - The font selection and font size
• "history" - Undo and Redo
• "mode" - Rich Text Mode and Source Code Mode
• "color" - Foreground and Background color
• "formatAll" - Bold, Italic, Underline, Superscript, Subscript, Strikethrough. If "formatAll" is in the list, "formatCommon" and "formatUncommon" will be ignored.
  • "formatCommon" - Bold, Italic, Underline
  • "formatUncommon" - Superscript, Subscript, Strikethrough
• "justify" - Left, Center, Right and Full Justify
• "list" - Bullet and Numbered List
• "indent" - Outdent and Indent
• "link" - Add and Remove Link
• "newline" - put the next thing on a new line
• "stretch" - adds a stretched component

Custom toolbox content: when the richTextEditor encounters a string in toolboxLayout that it doesn't recognize, like 'customToolbarXyz', it looks for a facet of that name and renders the content if it finds it. In the future new facets may be added to the richTextEditor. In order to avoid future name clashes strings starting with the word 'custom' should be used for custom facets. We make no guarantees for other names.

The toolboxLayout attribute allows the user to

• add as many custom toolbars as desired, for example
  • toolboxLayout="customToolbar1 all customToolbar2"
• stack as many toolbars as desired, for example
  • toolboxLayout="all newline customToolbar newline customGroup"
• show multiple rows of toolbars. for example
  • toolboxLayout="customToolbar1 newline all"
• reorder the button groups, for example
  • toolboxLayout="format color mode stretch history font"
• remove toolbar content that isn't desired, for example the date buttons won't show up with this:
  • toolboxLayout="font mode color format justify"

Returns:

the new toolboxLayout value

setToolboxLayout

public final void setToolboxLayout(String[] toolboxLayout)

Sets Allows control over the layout of the toolbar.

The built in strings the component recognizes are:

• "all" - all the buttons the richTextEditor provides by default - if "all" is in the list, all other built in strings are ignored
• "font" - The font selection and font size
• "history" - Undo and Redo
• "mode" - Rich Text Mode and Source Code Mode
• "color" - Foreground and Background color
• "formatAll" - Bold, Italic, Underline, Superscript, Subscript, Strikethrough. If "formatAll" is in the list, "formatCommon" and "formatUncommon" will be ignored.
  • "formatCommon" - Bold, Italic, Underline
  • "formatUncommon" - Superscript, Subscript, Strikethrough
• "justify" - Left, Center, Right and Full Justify
• "list" - Bullet and Numbered List
• "indent" - Outdent and Indent
• "link" - Add and Remove Link
• "newline" - put the next thing on a new line
• "stretch" - adds a stretched component

Custom toolbox content: when the richTextEditor encounters a string in toolboxLayout that it doesn't recognize, like 'customToolbarXyz', it looks for a facet of that name and renders the content if it finds it. In the future new facets may be added to the richTextEditor. In order to avoid future name clashes strings starting with the word 'custom' should be used for custom facets. We make no guarantees for other names.

The toolboxLayout attribute allows the user to

• add as many custom toolbars as desired, for example
  • toolboxLayout="customToolbar1 all customToolbar2"
• stack as many toolbars as desired, for example
  • toolboxLayout="all newline customToolbar newline customGroup"
• show multiple rows of toolbars. for example
  • toolboxLayout="customToolbar1 newline all"
• reorder the button groups, for example
  • toolboxLayout="format color mode stretch history font"
• remove toolbar content that isn't desired, for example the date buttons won't show up with this:
  • toolboxLayout="font mode color format justify"

Parameters:

toolboxLayout - the new toolboxLayout value

getDefaultEventName

public String getDefaultEventName()

Specified by:

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

Overrides:

getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public Collection<String> getEventNames()

Specified by:

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

getClientBehaviors

public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()

Specified by:

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

Overrides:

getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

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

Overrides:

addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXInput

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXInput

Skip navigation links