001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://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, please see the
018 * company website: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.ui.shared;
029
030import com.vaadin.shared.AbstractComponentState;
031
032/**
033 * State class for the CmsEditableGroupButtons component.<p>
034 */
035public class CmsEditableGroupButtonsState extends AbstractComponentState {
036
037    /** Serial version id. */
038    private static final long serialVersionUID = 1L;
039
040    /** True if hide option should be disabled.*/
041    protected boolean m_hideAddOption;
042
043    /** True if this is the button bar of the first row. */
044    protected boolean m_isFirst;
045
046    /** True if this is the button bar of the last row. */
047    protected boolean m_isLast;
048
049    /** Edit button visibility. */
050    private boolean m_editEnabled;
051
052    /**
053     * Default constructor.<p>
054     */
055    public CmsEditableGroupButtonsState() {
056
057        // do nothing
058    }
059
060    /**
061     * Return is add option hidden?
062     *
063     * @return m_hideAddOtion
064     */
065    public boolean isAddOptionHidden() {
066
067        return m_hideAddOption;
068    }
069
070    /**
071     * Returns true if the edit button should be enabled.
072     *
073     * @return true if the edit button should be enabled
074     */
075    public boolean isEditEnabled() {
076
077        return m_editEnabled;
078    }
079
080    /**
081     * Returns the isFirst.<p>
082     *
083     * @return the isFirst
084     */
085    public boolean isFirst() {
086
087        return m_isFirst;
088    }
089
090    /**
091     * Returns the isLast.<p>
092     *
093     * @return the isLast
094     */
095    public boolean isLast() {
096
097        return m_isLast;
098    }
099
100    /**
101     * Set m_hideAddOption.<p>
102     *
103     * @param hidden true if add should be hidden
104     */
105    public void setAddOptionHidden(boolean hidden) {
106
107        m_hideAddOption = hidden;
108    }
109
110    /**
111     * Enables/disables edit button.
112     *
113     * @param editEnabled true if edit button should be enabled
114     */
115    public void setEditEnabled(boolean editEnabled) {
116
117        m_editEnabled = editEnabled;
118    }
119
120    /**
121     * Sets the 'first' status (i.e. if this belongs to the first row.<p>
122     *
123     * @param isFirst true if the button bar belongs to the first row
124     */
125    public void setFirst(boolean isFirst) {
126
127        m_isFirst = isFirst;
128
129    }
130
131    /**
132     * Sets the 'last' status (i.e. if this belongs to the last row.<p>
133     *
134     * @param isLast true if the button bar belongs to the last row
135     */
136    public void setLast(boolean isLast) {
137
138        m_isLast = isLast;
139
140    }
141
142}