Create new RichFaces Documentation Jira issue
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.
JBoss.orgCommunity Documentation
The <rich:insert> component is used for highlighting, source code inserting and, optionally, format the file from the application context into the page.
Table 6.585. rich : insert attributes
| Attribute Name |
Description
|
|---|---|
| binding | JSF: The attribute takes a value-binding expression for a component property of a backing bean |
| content | Defines the String, inserted with this component. This attribute is alternative to "src" attribute. |
| encoding | Attribute defines encoding for inserted content |
| errorContent | Attribute defines the alternative content that will be shown in case component cannot read the resource defined with 'src' attribute. If "errorContent" attribute is not defined, the component shown the actual error message in the place where the content is expected |
| highlight | Defines a type of code |
| id | JSF: Every component may have a unique id that is automatically created if omitted |
| rendered | JSF: If "false", this component is not rendered |
| src | Defines the path to the file with source code |
Table 6.586. Component identification parameters
| Name | Value |
|---|---|
| component-type | org.richfaces.ui.Insert |
| component-class | org.richfaces.ui.component.html.HtmlInsert |
| component-family | org.richfaces.ui.Insert |
| renderer-type | org.richfaces.ui.InsertRenderer |
| tag-class | org.richfaces.ui.taglib.InsertTag |
To create the simplest variant on a page use the following syntax:
Example:
...
<rich:insert src="/pages/sourcePage.xhtml" highlight="xhtml"/>
...
Example:
import org.richfaces.ui.component.html.HtmlInsert;
...
HtmlInsert myInsert = new HtmlInsert();
...
The are two basic attributes. The "src" attribute defines the path to the file with source code. The "highlight" attribute defines the type of a syntax highlighting.
If "highlight" attribute is defined and JHighlight open source library is in the classpath, the text from the file is formated and colorized.
An example is placed below.
Example:
...
<rich:insert src="/pages/sourcePage.xhtml" highlight="xhtml"/>
...
The result of using <rich:insert> component is shown on the picture:
The <rich:insert> component provides the same functionality as JHighlight. Thus, all names of highlight style classes for source code of particular language could be changed to your names, which are used by the JHighlight library.
<rich:insert> has no skin parameters and custom style classes, as the component doesn't have own visual representation.
On RichFaces LiveDemo page you can found some additional information for <rich:insert> component usage.
