i_cmslistdirectaction.java

OpenCms 是一个J2EE的产品

/*
 * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/list/I_CmsListDirectAction.java,v $
 * Date   : $Date: 2006/03/27 14:52:27 $
 * Version: $Revision: 1.10 $
 *
 * This library is part of OpenCms -
 * the Open Source Content Mananagement System
 *
 * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library 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 library 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.
 *
 * For further information about Alkacon Software GmbH, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.workplace.list;

import org.opencms.workplace.CmsWorkplace;

/**
 * Interface for list direct action, that is an action that may be applied
 * directly on a list item.<p>
 * 
 * @author Michael Moossen  
 * 
 * @version $Revision: 1.10 $ 
 * 
 * @since 6.0.0 
 */
public interface I_CmsListDirectAction extends I_CmsListAction {

    /**
     * Generates a confirmation text div tag, to use in lists where all items use 
     * the same confirmation text.<p>
     * 
     * @param wp the workplace instance
     * 
     * @return html code
     */
    String confirmationTextHtml(CmsWorkplace wp);

    /**
     * Returns the id of the column to use as parameter for the helptext and confirmation message.<p>
     * 
     * @return the id of the column to use 
     */
    String getColumnForTexts();

    /**
     * Returns the current item.<p>
     * 
     * @return the current item
     */
    CmsListItem getItem();

    /**
     * Generates a help text div tag, to use in lists where all items use the same help text.<p>
     * 
     * @param wp the workplace instance
     * 
     * @return html code
     */
    String helpTextHtml(CmsWorkplace wp);

    /**
     * Sets the id of the column to use as parameter for the helptext and confirmation message.<p>
     * 
     * @param columnId the id of the column to use
     */
    void setColumnForTexts(String columnId);

    /**
     * Sets the current item, should be called before the <code>{@link #buttonHtml(org.opencms.workplace.CmsWorkplace)}</code> method.<p>
     * 
     * @param item the item
     */
    void setItem(CmsListItem item);

}