org.richfaces.component.AbstractSubTableToggleControl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of richfaces-components-ui Show documentation

There is a newer version: 4.3.7.Final

Show newest version

/*
 * JBoss, Home of Professional Open Source
 * Copyright ${year}, 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.UIComponentBase;

import org.richfaces.cdk.annotations.Attribute;
import org.richfaces.cdk.annotations.JsfComponent;
import org.richfaces.cdk.annotations.JsfRenderer;
import org.richfaces.cdk.annotations.Tag;

/**
 * @author Anton Belevich
 *
 */

@JsfComponent(
    type = AbstractSubTableToggleControl.COMPONENT_TYPE,
    family = AbstractSubTableToggleControl.COMPONENT_FAMILY, 
    generate = "org.richfaces.component.UISubTableToggleControl",
    renderer = @JsfRenderer(type = "org.richfaces.SubTableToggleControlRenderer"),
    tag = @Tag( name = "subTableToggleControl")
 )
public abstract class AbstractSubTableToggleControl extends UIComponentBase {

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

    public static final String COMPONENT_FAMILY = "org.richfaces.SubTableToggleControl";
    
    public static final String DEFAULT_EVENT = "onclick"; 
    
    enum PropertyKeys {
        forId
    }

    @Attribute
    public abstract String getExpandLabel();
    
    @Attribute
    public abstract String getCollapseLabel();

    @Attribute
    public abstract String getExpandIcon();

    @Attribute
    public abstract String getCollapseIcon();
    
    @Attribute(defaultValue = DEFAULT_EVENT)
    public abstract String getEvent();

    public String getFor() {
        return (String)getStateHelper().eval(PropertyKeys.forId);
    }
    
    public void setFor(String forId) {
        getStateHelper().put(PropertyKeys.forId, forId);
    }
}