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. As a convenience the richTextEditor component supports footer facets. There is more specific documentation about the facets in the "Supported Facets" section.
<section name="Supported_Features">The supported features are:
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:
Only html 4 tags are supported, with the exception of those listed below
We do support tags that pull in content such as applet, iframe, 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.
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 can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout or panelSplitter, if the dimensionsFrom attribute is set to "auto" or "parent" and the simple attribute is true. </html:li> <html:li>This component does not display any children so there are no child stretching capabilities.</html:li> </html:ul> </section>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. |
Modifier and Type | Field and Description |
---|---|
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 String |
DIMENSIONS_FROM_AUTO |
static String |
DIMENSIONS_FROM_CONTENT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DIMENSIONS_FROM_KEY |
static String |
DIMENSIONS_FROM_PARENT |
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 |
FOOTER_FACET |
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 String |
TOOLBAR_DISPLAY_INLINE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TOOLBAR_DISPLAY_KEY |
static String |
TOOLBAR_DISPLAY_POPUP |
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 |
CONVERSION_MESSAGE_ID, IMMEDIATE_KEY, LOCAL_VALUE_SET_KEY, PROTECTION_KEY_KEY, REQUIRED_KEY, REQUIRED_MESSAGE_DETAIL_KEY, REQUIRED_MESSAGE_ID, SUBMITTED_VALUE_KEY, TOKENIZE_MAP_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
Modifier | Constructor and Description |
---|---|
protected |
PartialRichTextEditor(String rendererType)
Construct an instance of the PartialRichTextEditor.
|
Modifier and Type | Method and Description |
---|---|
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 |
getDimensionsFrom()
Gets determines how the component will handle geometry management.
|
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 |
getFooter()
Content to be rendered as a footer.
|
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 |
getToolbarDisplay()
Gets how the toolbar should be shown.
|
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 |
setDimensionsFrom(String dimensionsFrom)
Sets determines how the component will handle geometry management.
|
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 |
setFooter(javax.faces.component.UIComponent footerFacet)
Content to be rendered as a footer.
|
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 |
setToolbarDisplay(String toolbarDisplay)
Sets how the toolbar should be shown.
|
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.
|
addValidator, addValueChangeListener, addValueUpdatedListener, broadcast, compareValues, getConvertedValue, getProtectionKey, getRequiredMessageDetail, getRequiredMessageKey, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, removeValueUpdatedListener, resetValue, setImmediate, setLocalValueSet, setProtectionKey, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, shouldInterpretEmptyStringSubmittedValuesAsNull, shouldValidateEmptyFields, updateModel, validate, validateValue
getConverter, getLocalValue, getValue, setConverter, setValue
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, 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
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, 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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String TOOLBAR_DISPLAY_INLINE
public static final String TOOLBAR_DISPLAY_POPUP
public static final String DIMENSIONS_FROM_AUTO
public static final String DIMENSIONS_FROM_CONTENT
public static final String DIMENSIONS_FROM_PARENT
public static final String EDIT_MODE_WYSIWYG
public static final String EDIT_MODE_SOURCE
public static final String CONTENT_DELIVERY_IMMEDIATE
public static final String CONTENT_DELIVERY_LAZY
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTO_SUBMIT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey READ_ONLY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REQUIRED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SIMPLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TOOLBAR_DISPLAY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMNS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DIMENSIONS_FROM_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey EDIT_MODE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROWS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TOOLBOX_LAYOUT_KEY
public static final String HELP_FACET
public static final String FOOTER_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
protected PartialRichTextEditor(String rendererType)
public final javax.faces.component.UIComponent getHelp()
public final void setHelp(javax.faces.component.UIComponent helpFacet)
public final javax.faces.component.UIComponent getFooter()
public final void setFooter(javax.faces.component.UIComponent footerFacet)
public final boolean isChanged()
public final void setChanged(boolean changed)
changed
- the new changed valuepublic final String getChangedDesc()
public final void setChangedDesc(String changedDesc)
changedDesc
- the new changedDesc valuepublic final boolean isAutoSubmit()
public final void setAutoSubmit(boolean autoSubmit)
autoSubmit
- the new autoSubmit valuepublic final char getAccessKey()
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.
public final void setAccessKey(char accessKey)
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.
accessKey
- the new accessKey valuepublic final String getContentStyle()
public final void setContentStyle(String contentStyle)
contentStyle
- the new contentStyle valuepublic final String getHelpTopicId()
public final void setHelpTopicId(String helpTopicId)
helpTopicId
- the new helpTopicId valuepublic final boolean isDisabled()
public final void setDisabled(boolean disabled)
disabled
- the new disabled valuepublic final String getLabel()
public final void setLabel(String label)
label
- the new label valuepublic final String getLabelStyle()
public final void setLabelStyle(String labelStyle)
labelStyle
- the new labelStyle valuepublic final boolean isReadOnly()
public final void setReadOnly(boolean readOnly)
readOnly
- the new readOnly valuepublic final boolean isShowRequired()
public final void setShowRequired(boolean showRequired)
showRequired
- the new showRequired valuepublic final boolean isSimple()
public final void setSimple(boolean simple)
simple
- the new simple valuepublic final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
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.
public final void setShortDesc(String shortDesc)
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.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final String[] getPersist()
public final void setPersist(String[] persist)
persist
- the new persist valuepublic final String[] getDontPersist()
public final void setDontPersist(String[] dontPersist)
dontPersist
- the new dontPersist valuepublic final String getToolbarDisplay()
public final void setToolbarDisplay(String toolbarDisplay)
toolbarDisplay
- the new toolbarDisplay valuepublic final int getColumns()
public final void setColumns(int columns)
columns
- the new columns valuepublic final String getDimensionsFrom()
public final void setDimensionsFrom(String dimensionsFrom)
dimensionsFrom
- the new dimensionsFrom valuepublic final String getEditMode()
public final void setEditMode(String editMode)
editMode
- the new editMode valuepublic final int getRows()
public final void setRows(int rows)
rows
- the new rows valuepublic final String getContentDelivery()
public final void setContentDelivery(String contentDelivery)
contentDelivery
- the new contentDelivery valuepublic final String[] getToolboxLayout()
The built in strings the component recognizes are:
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 topublic final void setToolboxLayout(String[] toolboxLayout)
The built in strings the component recognizes are:
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 totoolboxLayout
- the new toolboxLayout valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXInput
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXInput