AbstractRating.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright , Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.richfaces.component;

import javax.faces.component.UISelectOne;
import javax.faces.component.behavior.ClientBehaviorHolder;

import org.richfaces.cdk.annotations.Attribute;
import org.richfaces.cdk.annotations.EventName;
import org.richfaces.cdk.annotations.JsfComponent;
import org.richfaces.cdk.annotations.JsfRenderer;
import org.richfaces.cdk.annotations.Tag;
import org.richfaces.cdk.annotations.TagType;
import org.richfaces.renderkit.html.RatingRenderer;

@JsfComponent(tag = @Tag(name = "rating", type = TagType.Facelets),
    renderer = @JsfRenderer(family = AbstractRating.COMPONENT_FAMILY, type = RatingRenderer.RENDERER_TYPE), attributes = "core-props.xml")
public abstract class AbstractRating extends UISelectOne implements ClientBehaviorHolder {
// ------------------------------ FIELDS ------------------------------

    public static final String COMPONENT_FAMILY = "org.richfaces.Rating";

    public static final String COMPONENT_TYPE = "org.richfaces.Rating";

// ------------------------ INTERFACE METHODS ------------------------


// --------------------- Interface EditableValueHolder ---------------------

    @Attribute(defaultValue = "false")
    public abstract boolean isRequired();

// -------------------------- OTHER METHODS --------------------------

    @Attribute
    public abstract String getCancelLabel();

    @Attribute(events = @EventName("blur"))
    public abstract String getOnblur();

    @Attribute(events = @EventName(value = "click", defaultEvent = true))
    public abstract String getOnclick();

    @Attribute(events = @EventName("focus"))
    public abstract String getOnfocus();

    @Attribute
    public abstract Integer getSplit();

    @Attribute
    public abstract Integer getStarWidth();

    @Attribute(defaultValue = "false")
    public abstract boolean isReadonly();

    @Attribute
    public abstract String getItemStyleClass();
}