jsf UIComponent组件接口详细注释说明(jsf1.1规范)

UIComponent实现了StateHolder接口,StateHolder接口表示组件具有了状态。
StateHolder接口中常用到saveState,restoreState两个方法,在开发自定义组件的时候,需要实现它们,具体使用上经常是把 你的组件中全局变量进行状态化,就是在Object[]中定义它们,jsf在恢复和保存两个阶段分别调用组件的这两个方法,把页面的状态数据恢复在 Object[],把组件的Object[]数据渲染到页面。isTransient,setTransient方法表式,你的组件是否想状态化。

UIComponent组件主要api
1.public abstract java.util.Map getAttributes()  该方法会获得该组件的所有属性值

2. public abstract javax.faces.el.ValueBinding getValueBinding(java.lang.String name) 该方法会从组件的值绑定集合表中获取对应的值绑定对象,值绑定对象(ValueBinding )的目的是使用EL表达式解析你绑定的模型值,例如页面有个(#use.name),那么值绑定就会解析这个字符串,通过变量解析获取User对象,再用 值解析获取name值。

3.public abstract java.lang.String getClientId(javax.faces.context.FacesContext context) 主要是在UIViewRoot组件中生成组件在页面的映射Id,如果你为组件定义了一个id,那么他会基于这个id生成一个具有组件层次的客户端Id,使 用':'来分隔,如果没有为组件定义id,那么会动态生成一个id,例如会在页面渲染结果看到'form1:input1'这样的Id,就是告诉你一个 Input组件的id是'input',它在id是'form1'的form组件中。clientId常常在jsf内部对组件用来整理,定位。

 4.public abstract java.lang.String getFamily() 告诉你这个组件属于那个家族的,用的不多。主要是内部创建渲染类使用。

5. public abstract java.lang.String getId() 这个Id就是页面上你指定的组件Id,它可以让你方便的查找组件树上的组件,最好给你的页面组件都设定一个id,在服务端开发有时候会用到,如果没有设 定,jsf会自动生成一个唯一的id,如果自定义id在组件中有冲突,那么jsf会抛出id冲突异常。

6.public abstract javax.faces.component.UIComponent getParent() 得到该组件的父组件,注意:html标记不会成为一个组件。

7. public abstract boolean isRendered() 如果该组件这个方法设定为false,那么该组件以及它的子组件都会停止解码,验证,值更新,渲染等操作

8. public abstract java.lang.String getRendererType()  指定了该组件使用哪个渲染类进行渲染,这就是组件与渲染分离,并且互相可以复用的机制。

9. public abstract boolean getRendersChildren();  如果组件的此方法设定为真,那么jsf将继续寻找它的子组件进行渲染。否者渲染只渲染到当前组件。

10. public abstract java.util.List getChildren(); 获得该组件的直属子组件列表

11. public abstract int getChildCount() 获得获得该组件的直属子组件列表数

12.public abstract javax.faces.component.UIComponent findComponent(java.lang.String expr) 寻找该组件的子组件,通过页面上指定的组件Id,在它的父组件的findComponent去查找这个组件,一般用于自定义组件开发上,例如:jsf消息 渲染的时候就是通过findComponent方法去寻找for属性定义的组件。

13.public abstract java.util.Map getFacets() 得到该组件的所有facet类型的组件,facet组件主要作用:一个功能强大的组件中会有很多增强功能,这些增强功能可以定义成多个小的facet组 件,这样可以从组件的主功能中分解开,降低组件内部功能的耦合性,同时也可以做为组件的插件机制来扩展。

14.public abstract java.util.Iterator getFacetsAndChildren() 获取自己所以的直属子组件和facet组件,常用在子组件查找操作上,例如jsf核心机制中,遍历组件增加事件时就要递归使用此方法。

15.    public abstract void broadcast(javax.faces.event.FacesEvent event) 对于jsf生命周期的几个阶段都会用到递归遍历组件的事件,使用的就是这个方法,常用在内部机制上。标准的观察者模式。

16.    public abstract void decode(javax.faces.context.FacesContext context) jsf声明周期中的解码部分就是调用此方法,主要用在应用请求值阶段,通过递归遍历,每一个组件会在这个阶段操作request等容器对象来实现并隐藏 request请求的表现逻辑,并封装成事件交给组件的事件列表,由后面的阶段来处理。需要注意的是很可能此方法会把工作委托给渲染类的decode上, 所以jsf的渲染机制不仅仅是简单的输出html等展现标记,还用来封装和隐藏容器内的通信机制,让容器内对象从我们眼前消失!

17. 
    public abstract void encodeBegin(javax.faces.context.FacesContext context)
            throws java.io.IOException;
    public abstract void encodeChildren(javax.faces.context.FacesContext context)
            throws java.io.IOException;
    public abstract void encodeEnd(javax.faces.context.FacesContext context)
            throws java.io.IOException;
组件渲染阶段需要经历的步骤,渲染机制是一个复杂的过程,原理上是把tag标记渲染的工作委托给了servlet之上来处理,jsf 的tag标记只作为组件,视图之间的映射之用。这三个阶段更明确了渲染成视图标记这样一个工作,同样可以委托给渲染类去做。

 18.protected abstract void addFacesListener(javax.faces.event.FacesListener listener) 为组件增加监听,标准的观察者模式。

19.protected abstract javax.faces.event.FacesListener[] getFacesListeners(java.lang.Class clazz) 得到组件的监听列表,监听器在组件的事件列表遍历时会被调用,clazz参数是用来区分不同的监听器,目前常用 ActionListener.class,ValueChangeListener.class

20.protected abstract void removeFacesListener(javax.faces.event.FacesListener listener);从组件的监听列表中删除不需要的监听器。

21.public abstract void queueEvent(javax.faces.event.FacesEvent event) 把新创建的事件增加到组件的事件队列,此方法常常用在应用请求值阶段,每个组件会根据条件创建自己的事件,加入到事件列表,所有事件会全局的放入 UIViewRoot组件中,UIViewRoot组件是jsf各个阶段对组件树进行递归遍历处理的启动点。

22.
   public abstract void processRestoreState(javax.faces.context.FacesContext context,
                                             java.lang.Object state);
    public abstract void processDecodes(javax.faces.context.FacesContext context);
    public abstract void processValidators(javax.faces.context.FacesContext context);
    public abstract void processUpdates(javax.faces.context.FacesContext context);
    public abstract java.lang.Object processSaveState(javax.faces.context.FacesContext context);
    jsf生命周期中组件需要处理的五个重要阶段:恢复状态,解码,验证,更新,保持状态(另外包括调用应用,渲染),开发自定义组件,需要特别关注这些方面,渲染阶段由组件的编码方法实现,调用应用阶段则是actionListener监听器集合的处理期。

23. protected abstract javax.faces.context.FacesContext getFacesContext() 获取jsf上下文环境,FacesContext 是一个线程安全模型,在设计上接近pojo,所以在jsf环境对FacesContext的调用得到了简化,但是jsf整体的编程规则上更希望你能把 FacesContext 作为命令参数传递给各个实现细节,以保证上下文的真实性,这一点在开发自定义组件上要注意!
24. protected abstract javax.faces.render.Renderer getRenderer(javax.faces.context.FacesContext context) 获取当前组件的渲染类。

你可能感兴趣的:(JSF,职场,休闲)