com.hfg.xml.msofficexml.docx.wordprocessingml.WmlTabLeader Maven / Gradle / Ivy

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.xml.msofficexml.docx.wordprocessingml;

import java.util.Collection;
import java.util.Map;

import com.hfg.util.collection.OrderedMap;

//------------------------------------------------------------------------------
/**
 Allowed values for the tab 'leader' attribute which specifies the character to be
 repeated as required to fill the tab space.

 @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding 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 WmlTabLeader
{
   private static Map sValues = new OrderedMap<>(6);

   /**
    A dot.
    */
   public static final WmlTabLeader DOT      = new WmlTabLeader("dot");

   /**
    A heavy solid line or underscore.
    */
   public static final WmlTabLeader HEAVY   = new WmlTabLeader("heavy");

   /**
    A hyphen or dash.
    */
   public static final WmlTabLeader HYPHEN    = new WmlTabLeader("hyphen");

   /**
    A centered dot.
    */
   public static final WmlTabLeader MIDDLE_DOT  = new WmlTabLeader("middleDot");

   /**
    No leader character.
    */
   public static final WmlTabLeader NONE  = new WmlTabLeader("none");

   /**
    An underscore.
    */
   public static final WmlTabLeader UNDERSCORE  = new WmlTabLeader("underscore");

   private String mString;


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

   private WmlTabLeader(String inString)
   {
      mString = inString;
      sValues.put(inString, this);
   }


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

   //---------------------------------------------------------------------------
   public static Collection values()
   {
      return sValues.values();
   }

   //---------------------------------------------------------------------------
   public static WmlTabLeader valueOf(String inString)
   {
      return sValues.get(inString);
   }

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

   //---------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return name();
   }
}