001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.workplace.list;
029
030import org.opencms.workplace.tools.CmsHtmlIconButtonStyleEnum;
031
032import java.util.Locale;
033
034/**
035 * Implementation of a default action in a html list column.<p>
036 *
037 * @since 6.0.0
038 */
039public class CmsListDefaultAction extends CmsListDirectAction {
040
041    /** The id of column to use for the link. */
042    private String m_columnForLink;
043
044    /** The formatter to use for the link. */
045    private I_CmsListFormatter m_columnFormatter;
046
047    /**
048     * Default Constructor.<p>
049     *
050     * @param id unique id
051     */
052    public CmsListDefaultAction(String id) {
053
054        super(id);
055    }
056
057    /**
058     * Resturns the id of column to use for the link.<p>
059     *
060     * @return the id of column to use for the link
061     */
062    public String getColumnForLink() {
063
064        return m_columnForLink;
065    }
066
067    /**
068     * Resturns the formatter to use for the link.<p>
069     *
070     * @return the formatter to use for the link
071     */
072    public I_CmsListFormatter getColumnFormatter() {
073
074        return m_columnFormatter;
075    }
076
077    /**
078     * Sets the id of column to use for the link.<p>
079     *
080     * @param columnForLink the column to use for the link to set
081     */
082    public void setColumnForLink(CmsListColumnDefinition columnForLink) {
083
084        m_columnForLink = columnForLink.getId();
085        m_columnFormatter = columnForLink.getFormatter();
086    }
087
088    /**
089     * @see org.opencms.workplace.list.CmsListDirectAction#resolveButtonStyle()
090     */
091    @Override
092    protected CmsHtmlIconButtonStyleEnum resolveButtonStyle() {
093
094        if (getColumnForLink() == null) {
095            return super.resolveButtonStyle();
096        }
097        return CmsHtmlIconButtonStyleEnum.SMALL_ICON_TEXT;
098    }
099
100    /**
101     * @see org.opencms.workplace.list.CmsListDirectAction#resolveName(java.util.Locale)
102     */
103    @Override
104    protected String resolveName(Locale locale) {
105
106        if (getColumnForLink() == null) {
107            return super.resolveName(locale);
108        }
109        Object content = (getItem().get(getColumnForLink()) != null)
110        ? getItem().get(getColumnForLink())
111        : getName().key(locale);
112        if (getColumnFormatter() != null) {
113            return getColumnFormatter().format(content, locale);
114        }
115        return content.toString();
116    }
117}