org.richfaces.component.AbstractDragSource Maven / Gradle / Ivy
/*
* 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;
/**
*
* The <rich:dragSource> component can be added to a component to indicate it is capable of being dragged by the user.
* The dragged item can then be dropped into a compatible drop area, designated using the <rich:dropTarget> component.
*
* @author abelevich
*/
@JsfComponent(type = AbstractDragSource.COMPONENT_TYPE, family = AbstractDragSource.COMPONENT_FAMILY, generate = "org.richfaces.component.UIDragSource", renderer = @JsfRenderer(type = "org.richfaces.DragSourceRenderer"), tag = @Tag(name = "dragSource"))
public abstract class AbstractDragSource extends UIComponentBase {
public static final String COMPONENT_TYPE = "org.richfaces.DragSource";
public static final String COMPONENT_FAMILY = "org.richfaces.DragSource";
/**
* Component ID of a dragIndicator component that is used as drag pointer during the drag operation
*/
@Attribute
public abstract String getDragIndicator();
/**
* A drag zone type that is used for zone definition, which elements can be accepted by a drop zone
*/
@Attribute
public abstract String getType();
/**
* Data to be sent to a drop zone after a drop event
*/
@Attribute
public abstract Object getDragValue();
}