001// Copyright 2004, 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry.wml;
016
017import org.apache.tapestry.AbstractComponent;
018import org.apache.tapestry.IMarkupWriter;
019import org.apache.tapestry.IRequestCycle;
020
021/**
022 *  The onevent element binds a task to a particular intrinsic event for the immediately enclosing element, ie,
023 *  specifying an onevent element inside an "XYZ" element associates an intrinsic event binding with the "XYZ" element.
024 *  The user agent must ignore any onevent element specifying a type that does not correspond to a legal intrinsic event
025 *  for the immediately enclosing element.
026 *
027 *  @author David Solis
028 *  @since 3.0
029 *
030 **/
031
032public abstract class OnEvent extends AbstractComponent
033{
034    /**
035     *  @see AbstractComponent#renderComponent(IMarkupWriter, IRequestCycle)
036     **/
037
038    protected void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
039    {
040        boolean render = !cycle.isRewinding();
041
042        if (render)
043        {
044            writer.begin("onevent");
045
046            writer.attribute("type", getType());
047
048            renderInformalParameters(writer, cycle);
049        }
050
051        renderBody(writer, cycle);
052
053        if (render)
054        {
055            writer.end();
056        }
057    }
058
059    public abstract String getType();
060
061}