KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > wml > Do


1 // Copyright 2004, 2005 The Apache Software Foundation
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 package org.apache.tapestry.wml;
16
17 import org.apache.hivemind.HiveMind;
18 import org.apache.tapestry.AbstractComponent;
19 import org.apache.tapestry.IMarkupWriter;
20 import org.apache.tapestry.IRequestCycle;
21
22 /**
23  * The do element provides a general mechanism for the user to act upon the current card, in other
24  * words a card-level user interface element. The representation of the do element is user agent
25  * dependent and the author must only assume that the element is mapped to a unique user interface
26  * widget that the user can activate. For example, the widget mapping may be to a graphically
27  * rendered button, a soft or function key, a voice-activated command sequence, or any other
28  * interface that has a simple "activate" operation with no inter-operation persistent state. The do
29  * element may appear at both the card and deck-level.
30  *
31  * @author David Solis
32  * @since 3.0
33  */
34
35 public abstract class Do extends AbstractComponent
36 {
37     /**
38      * @see AbstractComponent#renderComponent(IMarkupWriter, IRequestCycle)
39      */
40
41     protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
42     {
43         boolean render = !cycle.isRewinding();
44
45         if (render)
46         {
47             writer.begin("do");
48
49             writer.attribute("type", getType());
50
51             String JavaDoc label = getLabel();
52             if (HiveMind.isNonBlank(label))
53                 writer.attribute("label", label);
54
55             renderInformalParameters(writer, cycle);
56         }
57
58         renderBody(writer, cycle);
59
60         if (render)
61             writer.end();
62     }
63
64     public abstract String JavaDoc getType();
65
66     public abstract String JavaDoc getLabel();
67 }
Popular Tags