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, 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.gwt.client.property;
029
030import org.opencms.gwt.client.ui.input.I_CmsFormField;
031
032/**
033 * Represents information about which field in the property editor dialog is active.<p>
034 */
035public class CmsActiveFieldData {
036
037    /** The tab. */
038    public String m_page;
039
040    /** The property name. */
041    public String m_property;
042
043    /** The selected field. */
044    private I_CmsFormField m_field;
045
046    /**
047     * Creates a new instance.<p>
048     *
049     * @param field the field
050     * @param tab the tab
051     * @param property the property name
052     */
053    public CmsActiveFieldData(I_CmsFormField field, String tab, String property) {
054        m_field = field;
055        m_page = tab;
056        m_property = property;
057    }
058
059    /**
060     * Gets the field.<p>
061     *
062     * @return the field
063     */
064    public I_CmsFormField getField() {
065
066        return m_field;
067    }
068
069    public String getFieldId() {
070
071        return (m_field != null) ? m_field.getId() : "(null)";
072    }
073
074    /**
075     * Gets the property name.<p>
076     *
077     * @return the property name
078     */
079    public String getProperty() {
080
081        return m_property;
082    }
083
084    /**
085     * Gets the tab name .<p>
086     *
087     * @return the tab
088     */
089    public String getTab() {
090
091        return m_page;
092    }
093
094    /**
095     * @see java.lang.Object#toString()
096     */
097    @Override
098    public String toString() {
099
100        return m_page + ":" + m_property;
101    }
102
103}