KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > tools > guiframework > view > DescriptorCCPrimaryMasthead


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 package com.sun.enterprise.tools.guiframework.view;
25
26 import com.iplanet.jato.NavigationException;
27 import com.iplanet.jato.RequestContext;
28 import com.iplanet.jato.model.ModelControlException;
29 import com.iplanet.jato.view.ContainerView;
30 import com.iplanet.jato.view.View;
31 import com.iplanet.jato.view.event.ChildDisplayEvent;
32 import com.iplanet.jato.view.event.ChildContentDisplayEvent;
33 import com.iplanet.jato.view.event.DisplayEvent;
34
35 import com.sun.enterprise.tools.guiframework.exception.ChildNotRegisteredException;
36 import com.sun.enterprise.tools.guiframework.view.descriptors.ViewDescriptor;
37
38 import com.sun.web.ui.model.CCMastheadModelInterface;
39 import com.sun.web.ui.view.masthead.CCPrimaryMasthead;
40
41
42 public class DescriptorCCPrimaryMasthead extends CCPrimaryMasthead implements DescriptorContainerView {
43
44     /**
45      * Constructor.
46      */
47     public DescriptorCCPrimaryMasthead(RequestContext ctx, ContainerView container, String JavaDoc name, ViewDescriptor desc, CCMastheadModelInterface model) {
48         super(container, model, name);
49         // This is not necessary, but good practice.
50 setDefaultModel(model);
51         setRequestContext(ctx);
52         setViewDescriptor(desc);
53         registerViewDescriptorChildren();
54     }
55
56     /**
57      * This method retrieves this View ViewDescriptor.
58      *
59      * @return This View's ViewDescriptor.
60      */
61     public ViewDescriptor getViewDescriptor() {
62         return _viewDesc;
63     }
64
65     /**
66      * This method sets the ViewDescriptor for this View.
67      */
68     protected void setViewDescriptor(ViewDescriptor desc) {
69         _viewDesc = desc;
70     }
71
72     /**
73      * This method registerd the Descriptor children.
74      */
75     public void registerViewDescriptorChildren() {
76         DescriptorViewHelper.registerViewDescriptorChildren(
77         getViewDescriptor(), this);
78     }
79
80     /**
81      * This method is defined in ContainerView, but it is important to
82      * to override this.
83      *
84      * This method should delegate to the helper createChild method to use the
85      * descriptor information
86      */
87     public View createChild(String JavaDoc name) {
88         // Try to create the Child via a child descriptor
89 View child = null;
90         try {
91             child = DescriptorViewHelper.createChild(this, name);
92         } catch (ChildNotRegisteredException ex) {
93             // Some children have built-in support via the super class
94 child = super.createChild(name);
95         }
96
97         // return the child
98 return child;
99     }
100
101     /**
102      *
103      */
104     public RequestContext getRequestContext() {
105         return _reqCtx;
106     }
107
108     /**
109      *
110      */
111     public void setRequestContext(RequestContext context) {
112         _reqCtx = context;
113     }
114
115     public void forwardTo(RequestContext requestContext) throws NavigationException {
116         getParentViewBean().forwardTo(requestContext);
117     }
118
119     ////////////////////////////////////////////////////////////
120 // Event Methods //
121 ////////////////////////////////////////////////////////////
122
123     /**
124      * This method dispatches BeginDisplay events to each registered
125      * BeginDisplay event handler according the the ViewDescriptor.
126      * This method is defined in ContainerView, but it is important to
127      * to override this.
128      *
129      * @param event The DisplayEvent, created internally by JATO
130      */
131     public void beginDisplay(DisplayEvent event) throws ModelControlException {
132         DescriptorViewHelper.beginDisplay(this, event);
133         super.beginDisplay(event);
134     }
135
136     public boolean beginChildDisplay(ChildDisplayEvent event) throws ModelControlException {
137         return DescriptorViewHelper.beginChildDisplay(this, event);
138     }
139
140     public String JavaDoc endChildDisplay(ChildContentDisplayEvent event) throws ModelControlException {
141         return DescriptorViewHelper.endChildDisplay(this, event);
142     }
143
144     public void endDisplay(DisplayEvent event) {
145         DescriptorViewHelper.endDisplay(this, event);
146         super.endDisplay(event);
147     }
148
149     private RequestContext _reqCtx = null;
150     private ViewDescriptor _viewDesc = null;
151 }
152
Popular Tags