001// Copyright 2013 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.components;
016
017import org.apache.tapestry5.BindingConstants;
018import org.apache.tapestry5.ComponentResources;
019import org.apache.tapestry5.MarkupWriter;
020import org.apache.tapestry5.annotations.Parameter;
021import org.apache.tapestry5.annotations.SupportsInformalParameters;
022import org.apache.tapestry5.ioc.annotations.Inject;
023
024/**
025 * Renders a {@code <span>} tag with the CSS class to select a <a href="http://getbootstrap.com/components/#glyphicons">Bootstrap Glyphicon</a>.
026 * 
027 * If Twitter Bootstrap 3 isn't enabled (i.e @{link Trait#BOOTSTRAP_3 is set to false),
028 * this usages of this component are automatically and transparently replaced by {@link FontAwesomeIcon}.
029 *
030 * @see org.apache.tapestry5.services.compatibility.Trait#BOOTSTRAP_3
031 *
032 * @tapestrydoc
033 * @since 5.4
034 */
035@SupportsInformalParameters
036public class Glyphicon
037{
038    /**
039     * The name of the icon, e.g., "arrow-up", "flag", "fire" etc.
040     */
041    @Parameter(required = true, allowNull = false, defaultPrefix = BindingConstants.LITERAL)
042    String name;
043
044    @Inject
045    ComponentResources resources;
046
047    boolean beginRender(MarkupWriter writer)
048    {
049        writer.element("span",
050                "class", "glyphicon glyphicon-" + name);
051        resources.renderInformalParameters(writer);
052        writer.end();
053
054        return false;
055    }
056}