Oracle Fusion Middleware Tag Reference for Oracle ADF Faces
12c (12.1.2)
E23188-01

<af:codeEditor>

UIComponent class: oracle.adf.view.rich.component.rich.input.RichCodeEditor
Component type: oracle.adf.RichCodeEditor

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.

Supported Facets

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

Attributes

Name	Type	Supports EL?	Description
accessKey	char	Yes	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.
attributeChangeListener	javax.el.MethodExpression	Only EL	a method reference to an attribute change listener. 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 events might include the width of a column that supported client-side resizing.
autoSubmit	boolean	Yes	Default Value: false 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.
binding	oracle.adf.view.rich.component.rich.input.RichCodeEditor	Only EL	an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
changed	boolean	Yes	Default Value: false an attribute which if set to true, the changed indicator icon will be displayed on the component.
changedDesc	String	Yes	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.
clientComponent	boolean	Yes	Default Value: false 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.
columns	int	Yes	Default Value: 85 the size of the text control specified by the number of characters shown. The number of columns is estimated based on the default font size of the browser.
contentDelivery	String	Yes	Valid Values: immediate, lazy Default Value: immediate 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.
contentStyle	String	Yes	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.
converter	javax.faces.convert.Converter	Yes	a converter object
customizationId	String	Yes	This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
dimensionsFrom	String	Yes	Valid Values: auto, content, parent Default Value: auto determines how the component will handle geometry management. This specifies where the dimensions of the codeEditor come from: auto - either "content" or "parent", depending on the container the codeEditor is inside; if the codeEditor is being stretched by its ancestor then "parent" will be used, otherwise "content" will be used. content - the codeEditor will get its dimensions from the component content. parent - the codeEditor will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin.
disabled	boolean	Yes	Default Value: false 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.
helpTopicId	String	Yes	the id used to look up a topic in a helpProvider.
id	String	No	the identifier for the component. Every component may be named by a component identifier that must conform to the following rules: They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ). Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
immediate	boolean	Yes	Default Value: false whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.
inlineStyle	String	Yes	the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex 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. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.
label	String	Yes	the label of the component. If you want the label to appear above the control, use a panelFormLayout.
labelAndAccessKey	String	Yes	an attribute that will simultaneously set both the "label" and "accessKey" attributes from a single value, using conventional ampersand ('&') notation. For example, setting this attribute to "L&abel" will set the label to "Label" and the access key to 'a'.
labelStyle	String	Yes	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.
language	String	Yes	Valid Values: xml, javascript, groovy Default Value: text
lineNumbers	String	Yes	Valid Values: yes, no Default Value: yes Whether or not to show line numbers. Defaults to 'yes'.
partialTriggers	String[]	Yes	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.
readOnly	boolean	Yes	Default Value: false 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.
rendered	boolean	Yes	Default Value: true whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
required	boolean	Yes	Default Value: false whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.
requiredMessageDetail	String	Yes	the message to be displayed, if 'required' validation fails. Parameters: {0} the label that identifies the component
rows	int	Yes	Default Value: 5 the height of the text control specified by the number of characters shown. The default value is 1, which generates a one-row input field. The number of rows is estimated based on the default font size of the browser.
shortDesc	String	Yes	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.
showRequired	boolean	Yes	Default Value: false 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.
simple	boolean	Yes	Default Value: false 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.
styleClass	String	Yes	a CSS style class to use for this component. The styleClass attribute value is rendered on the root dom element. We provide some public style classes you can set the styleClass to that will affect only the 'content' piece of the component. These are: AFAddressFieldTextMarker, AFPostalCodeFieldTextMarker, AFPhoneFieldTextMarker, AFFieldNumberMarker, AFFieldTextLTRMarker, AFFieldTextMarker, AFFieldNumberMarker. In LTR languages, these styles have no effect by default, other than AFFieldNumberMarker which right aligns the text. They have more styling in RTL mode. If needed, you can skin the public style definitions for these marker style classes (e.g., AFAddressFieldText, AFPostalCodeFieldText, etc.) and it will be picked up by using these "Marker" style class because in our base skin implementation we map to the public style by doing this: af\|codeEditor.AFFieldNumberMarker af\|codeEditor::content {-tr-rule-ref:selector(".AFFieldNumber")}. We recommend that you do not add style properties to the "Marker" style classes, since they are used solely in the CSS descendant selector to point to the content pseudo-element.
toolboxLayout	String[]	Yes	Valid Values: all, history Allows control over the layout of the toolbar. The built in strings the component recognizes are: "all" - all the buttons the richCodeEditor provides by default - if "all" is in the list, all other built in strings are ignored "history" - Undo and Redo Custom toolbox content: when the codeEditor 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 codeEditor. 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 mode buttons won't show up with this: toolboxLayout="history"
unsecure	java.util.Set	Yes	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.
validator	javax.faces.el.MethodBinding	Only EL	a method reference to a validator method
value	Object	Yes	the value of the component. If the EL binding for the "value" points to a bean property with a getter but no setter, and this is an editable component, the component will be rendered in read-only mode.
valueChangeListener	javax.faces.el.MethodBinding	Only EL	a method reference to a value change listener
visible	boolean	Yes	Default Value: true 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. Not supported on the following renderkits: org.apache.myfaces.trinidad.core