org.vaadin.spring.stuff.sidebar.SideBarItemIcon Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-vaadin-stuff Show documentation

There is a newer version: 0.0.3.2

/*
 * Copyright 2014 The original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.vaadin.spring.stuff.sidebar;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Meta annotation designed to be placed on icon annotations that are used to specify an icon of a {@link org.vaadin.spring.stuff.sidebar.SideBarItem}.
 *
 * @author Petter Holmström ([email protected])
 * @see org.vaadin.spring.stuff.sidebar.FontAwesomeIcon
 * @see org.vaadin.spring.stuff.sidebar.ThemeIcon
 * @see org.vaadin.spring.stuff.sidebar.LocalizedThemeIcon
 */
@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface SideBarItemIcon {

    /**
     * The class of the {@link org.vaadin.spring.stuff.sidebar.SideBarItemIconProvider} that knows how to provide
     * the actual icon {@link com.vaadin.server.Resource}s. An instance of this class will be looked up from the
     * Spring application context, so make sure your icon provider is Spring managed.
     */
    Class value();

}