创建自定义JSF组件指南

需积分: 1 161 浏览量更新于2024-07-24 收藏 408KB PDF 举报

"如何开发自定义JSF组件" 在JavaServer Faces (JSF) 技术中，开发自定义JSF组件是提升应用程序界面功能和灵活性的重要方式。JSF允许开发者利用UI组件作为构建模块，简化开发过程，减少代码量，并实现组件在不同项目间的复用。标准的JSF参考实现提供了基础的Web组件，但有时我们需要根据具体需求创建定制的组件。本教程将引导你逐步完成自定义JSF组件的开发。 **构建教程的结构** 在开始开发之前，你需要了解以下目录结构： 1. **AntFolder**: 存放构建脚本，如Ant构建文件，用于编译和打包组件。 2. **ExtLibFolder**: 用于存放扩展库，可能包含你需要的依赖。 3. **JavaSourceFolder**: 存放Java源代码，包括你的组件类。 4. **WebContentFolder**: 包含Web应用相关的文件，如HTML、CSS、JavaScript以及组件的元数据。 5. **RootFolder**: 项目的根目录，包含了上述所有子目录。 **构建组件的一般提示** 开发组件时，遵循以下步骤： 1. **组件骨架(Step1: Components Skeleton)**: 创建一个基本的组件类，它需要继承自JSF提供的UIComponent基类或者其特定的子类，如UIInput或UICommand。 2. **添加简单属性(Step2: Adding Simple Attributes)**: 定义组件的属性，这些属性可以是基本类型，也可以是其他对象。你需要覆盖`get`和`set`方法来处理这些属性。 3. **添加JSF支持属性(Step3: Adding JSF Support Attributes)**: 为了使组件与JSF生命周期更好地集成，需要实现如`decode`、`encodeBegin`、`encodeEnd`等方法。 4. **属性绑定(Step4: Attribute Binding)**: 允许将组件的属性绑定到Managed Bean的属性，实现动态属性值的设置。 5. **组件绑定(Step5: Component Binding)**: 对于更复杂的场景，可以绑定整个组件到Managed Bean，以进行更灵活的控制和操作。 6. **最终版本(Step6: Final Version)**: 在完成上述步骤后，你的组件应该已经具备了基本功能，可以根据实际需求进一步优化和测试。 7. **创建可部署JAR文件(Step7: Creating a Deployable Jar File)**: 打包组件为JAR文件，以便在其他JSF应用中使用。 **接下来做什么？** 完成组件开发后，你可以： - 将组件集成到你的JSF应用中，通过`<cc:component>`标签引用。 - 测试组件在不同浏览器和环境下的兼容性。 - 编写文档，描述组件的使用方法和特性。 **额外的话题** 在深入学习JSF组件开发时，还可以探索以下主题： - 组件的国际化和本地化支持。 - 使用Facelets进行组件的声明式配置。 - 了解并使用自定义事件和监听器。 - 掌握富客户端组件(Rich Client Components)的开发。 - 理解和使用JSF的渲染树和生命周期。 **JSF资源** 为了进一步提升JSF组件开发技能，你可以参考以下资源： - Sun/Oracle官方JSF文档：提供详细的API参考和技术指南。 - JSF框架的开源实现，如Mojarra和MyFaces，它们通常有丰富的示例和社区支持。 - StackOverflow和相关的开发者论坛，可以在那里找到解决常见问题的答案。开发自定义JSF组件需要理解JSF的基础概念和生命周期，通过实践和不断学习，你将能够创建出满足特定需求的强大组件。

How to Write Your Own JSF Components Step 1: Components Skeleton

page 6 of 32

Step 1: Components Skeleton

Before we start, let’s see what we have at the beginning. The initial project taken from the

Step0 folder contains a short example that does nothing except open the bannerpage.jsp page

when the application starts. This JSP page will be used as a testing area for testing the rendered

component output.

After the final step we have got a scrollable area with the text inside. It will look like the

following picture:

In the first step we create a component that will be rendered into the following code in the

resulting HTML page:

<div>Hello JSF Component</div>

On the original JSF page we will have:

<d:ticker>

<f:verbatim>Hello JSF Component</f:verbatim>

</d:ticker>

Let’s start with creating the tag library definition file. Open the WEB-INF folder and create

a “ticker.tld” file that contains the following code:

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE taglib PUBLIC "-//Sun Microsystems, Inc.//DTD JSP Tag Library 1.2//EN"

"http://java.sun.com/dtd/web-jsptaglibrary_1_2.dtd">

<tlib-version>1.0</tlib-version>

<jsp-version>1.2</jsp-version>

<short-name>d</short-name>

<uri>http://jsftutorials.com/</uri>

<tag>

<name>ticker</name>

<tag-class>ticker.TickerTag</tag-class>

<body-content>JSP</body-content>

</tag>

</taglib>

We have declared the new tag with the name “ticker” and defined ticker.TickerTag as a tag

class. Open JavaSource folder; create a package “ticker” there and the class TickerTag there that

contains the following code:

How to Write Your Own JSF Components Step 1: Components Skeleton

page 7 of 32

package ticker;

import javax.faces.component.UIComponent;

import javax.faces.webapp.UIComponentTag;

public class TickerTag extends UIComponentTag{

public void release() {

// the super class method should be called

super.release();

}

protected void setProperties(UIComponent component) {

// the super class method should be called

super.setProperties(component);

}

public String getComponentType() {

return "ticker";

}

public String getRendererType() {

// null means the component renders itself

return null;

}

The class TickerTag processes the tag attribute. Such a class name has the suffix ”Tag” by a

naming convention. The TickerTag class extends UIConponentTag and implements four

methods.

The getComponentType() method returns the symbolic name of the component type. We

will define the class for this type latter in the faces-config file.

The getRendererType() method returns the symbolic name of the renderer. If

getRendererType() returns null, it means that the renderer name is not defined and the

component will render it by itself.

The release() method releases any resources allocated during the execution of this tag

handler. We will use this method to reset the attribute values. The release() method should call

the release() method of the super class.

And the last (but not least) method, setProperties(UIComponent component), is used to pass

attributes taken from the JSP page to the renderer. You can use the JSF Expression Language in

the value for the tag attribute. This is also resolved by the setProperties method. We will return

back to this theme in step 4 of this tutorial.

Now let’s define the component class for the component type declared above. Open WEB-

INF/faces-config.xml and put the declaration there. The faces-config.xml should contain the

following code:

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE faces-config PUBLIC "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN"

"http://java.sun.com/dtd/web-facesconfig_1_0.dtd">

<faces-config>

<component-type>ticker</component-type>

<component-class>ticker.UITicker</component-class>

</component>

剩余31页未读，继续阅读

hheee

粉丝: 0
资源: 2

创建自定义JSF组件指南

Developing Custom JSF Components For NetBeans Visual Web Pack.zip

develop_jsf_with_jbuilder.pdf

JSF components-开源

RichFaces - Open Source Rich JSF Components

faceless:JSF到Web Components的转换器

Pro JSF and Ajax Building Rich Internet Components

Put JSF to work

JSF

jsf

andromda-jsf-cartridge-components-3.3.jar

最新资源