001// Copyright 2006, 2007, 2011 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.tapestry5.corelib.mixins;
016
017import org.apache.tapestry5.annotations.BeforeRenderBody;
018import org.apache.tapestry5.annotations.MixinAfter;
019
020/**
021 * Discards a component's body. Returns false from the {@link BeforeRenderBody} phase, which prevents the rendering of
022 * the body. Set up as a "MixinAfter" so that components can render their an alternative body if they so desire before
023 * this mixin cancels the normal body (from the container's template).
024 * 
025 * @tapestrydoc
026 */
027@MixinAfter
028public class DiscardBody
029{
030    boolean beforeRenderBody()
031    {
032        return false;
033    }
034}