| gvSIG desktop 1

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2007 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 */

package org.gvsig.gui.beans.panelGroup.panels;

import javax.swing.JPanel;

import org.gvsig.gui.beans.panelGroup.AbstractPanelGroup;

/**

 * <p>Represents a {@link JPanel JPanel} adapted to work as a panel of an {@link AbstractPanelGroup  AbstractPanelGroup}.</p>

 *  

 * @see JPanel

 * @see IPanel

 * 

 * @see AbstractPanelGroup

 * 

 * @version 16/10/2007

 * @author Pablo Piqueras Bartolom? (pablo.piqueras@iver.es) 

 */

public abstract class AbstractPanel extends JPanel implements IPanel {

        /**

         * <p>Optional attribute that identifies this panel.</p>

         * 

         * @see #getID()

         * @see #setID(String)

         */

        private String id;

        /**

         * <p>Identifier used by a {@link AbstractPanelGroup AbstractPanelGroup} to identify this panel.</p>

         * 

         * @see #getLabel()

         * @see #setLabel(String)

         */

        private String label;

        /**

         * <p>Identifier used to group together different <code>IPanel</code> panels

     *      in a {@link AbstractPanelGroup AbstractPanelGroup}</p>

     *

     * @see #getLabelGroup()

     * @see #setLabelGroup(String)

         */

        private String labelGroup;

        /**

         * <p>Reference to an object that is related this panel</p>

         * 

         * @see #setReference(Object)

         * @see #getReferenceClass()

         */

        private Object reference;

        /**

         * <p>Initializes this panel.</p>

         */

        public AbstractPanel() {

                super();

                this.id = null;

                this.label = null;

                this.labelGroup = null;

        }

        /**

         * <p>Initializes this panel using three parameters.</p>

         * 

         * @param id optional attribute that identifies this panel

         * @param label identifier used by a {@link AbstractPanelGroup AbstractPanelGroup} to identify this panel

         * @param labelGroup identifier used to group together different <code>IPanel</code> panels

     *      in a {@link AbstractPanelGroup AbstractPanelGroup}

         */

        public AbstractPanel(String id, String label, String labelGroup) {

                super();

                this.id = id;

                this.label = label;

                this.labelGroup = labelGroup;

        }

        /**

         * <p>This method is used by each concrete implementation of <code>AbstractPanel</code> to

         *  execute its particular initialization tasks.</p>

         */

        protected abstract void initialize();

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#getID()

         */

        public String getID() {

                return id;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#getLabel()

         */

        public String getLabel() {

                return label;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#getLabelGroup()

         */

        public String getLabelGroup() {

                return labelGroup;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#setID(java.lang.String)

         */

        public void setID(String id) {

                this.id = id;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#setLabel(java.lang.String)

         */

        public void setLabel(String label) {

                this.label = label;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#setLabelGroup(java.lang.String)

         */

        public void setLabelGroup(String labelGroup) {

                this.labelGroup = labelGroup;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#getReferenceClass()

         */

        public Class getReferenceClass() {

                return (reference == null)? null : reference.getClass(); 

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#accept()

         */

        public abstract void accept();

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#apply()

         */

        public abstract void apply();

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#cancel()

         */

        public abstract void cancel();

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#selected()

         */

        public abstract void selected();

        /*

         * (non-Javadoc)

         * @see org.gvsig.gui.beans.panelGroup.panels.IPanel#setReference(java.lang.Object)

         */

        public void setReference(Object ref) {

                reference = ref;

        }

        /*

         * (non-Javadoc)

         * @see java.awt.Component#toString()

         */

        public String toString() {

                return (label == null)? "": label;

        }

}