com.hfg.javascript.ext.ExtGridColList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.javascript.ext;

import com.hfg.xml.XMLTag;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

//------------------------------------------------------------------------------
/**
 An ordered and named collection of ExtJs grid columns.
 
 @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg Library
//
// 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.
//
// 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
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class ExtGridColList extends ArrayList
{
   private String mName;


   private static final String XML_TAG_NAME = "ExtGridColList";
   private static final String XML_COLUMNS  = "Columns";
   private static final String XML_NAME_ATT = "name";

   //##########################################################################
   // CONSTRUCTORS
   //##########################################################################

   //--------------------------------------------------------------------------
   public ExtGridColList()
   {
      super();
   }

   //--------------------------------------------------------------------------
   public ExtGridColList(int inInitialSize)
   {
      super(inInitialSize);
   }

   //--------------------------------------------------------------------------
   public ExtGridColList(Collection inValues)
   {
      super(inValues);
   }

   //--------------------------------------------------------------------------
   public ExtGridColList(XMLTag inXMLTag)
   {
      this();

      inXMLTag.verifyTagName(XML_TAG_NAME);

      setName(inXMLTag.getAttributeValue(XML_NAME_ATT));

      XMLTag columnsTag = inXMLTag.getOptionalSubtagByName(XML_COLUMNS);
      if (columnsTag != null)
      {
         for (XMLTag subtag : (List) (Object) columnsTag.getSubtags())
         {
            add(new ExtGridCol(subtag));
         }
      }
   }

   //##########################################################################
   // PUBLIC METHODS
   //##########################################################################

   //--------------------------------------------------------------------------
   public String name()
   {
      return mName;
   }

   //--------------------------------------------------------------------------
   public ExtGridColList setName(String inValue)
   {
      mName = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public XMLTag toXMLTag()
   {
      XMLTag tag = new XMLTag(XML_TAG_NAME);
      tag.setAttribute(XML_NAME_ATT, name());

      if (size() > 0)
      {
         XMLTag columnsTag = new XMLTag(XML_COLUMNS);
         tag.addSubtag(columnsTag);

         for (ExtGridCol col : this)
         {
            columnsTag.addSubtag(col.toXMLTag());
         }
      }

      return tag;
   }
}