net.sf.mpxj.mpp.GanttBarStyleException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mpxj Show documentation

Library that provides facilities to allow project information to be manipulated in Java and .Net. Supports a range of data formats: Microsoft Project Exchange (MPX), Microsoft Project (MPP,MPT), Microsoft Project Data Interchange (MSPDI XML), Microsoft Project Database (MPD), Planner (XML), Primavera (PM XML, XER, and database), Asta Powerproject (PP, MDB), Asta Easyplan (PP), Phoenix Project Manager (PPX), FastTrack Schedule (FTS), and the Standard Data Exchange Format (SDEF).

There is a newer version: 13.4.0

Show newest version

/*
 * file:       GanttBarStyleException.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2005
 * date:       Apr 13, 2005
 */

/*
 * 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.
 */

package net.sf.mpxj.mpp;

import java.io.ByteArrayOutputStream;
import java.io.PrintWriter;

/**
 * This class represents the default style for a Gantt chart bar.
 */
public final class GanttBarStyleException extends GanttBarCommonStyle
{
   /**
    * Retrieve the unique task ID for the task to which this style
    * exception applies.
    *
    * @return task ID
    */
   public int getTaskUniqueID()
   {
      return (m_taskUniqueID);
   }

   /**
    * Sets the task unique ID.
    *
    * @param id task unique ID
    */
   public void setTaskUniqueID(int id)
   {
      m_taskUniqueID = id;
   }

   /**
    * Retrieves the index of the bar style to which this exception applies.
    * The standard bar styles are held in an array, retrieved using the
    * GanttChartView.getBarStyles() method. The index returned by this method
    * is an index into the array of bar styles. The significance of this is
    * that a single bar on a Gantt chart could have one or more exceptions
    * associated wit it, but the exceptions will only be applied if the style
    * of the bar currently being displayed matches the style recorded here
    * in the style exception.
    *
    * @return bar style index
    */
   public int getBarStyleIndex()
   {
      return (m_barStyleIndex);
   }

   /**
    * Sets the bar style index.
    *
    * @param index bar style index
    */
   public void setBarStyleIndex(int index)
   {
      m_barStyleIndex = index;
   }

   /**
    * Generate a string representation of this instance.
    *
    * @return string representation of this instance
    */
   @Override public String toString()
   {
      ByteArrayOutputStream os = new ByteArrayOutputStream();
      PrintWriter pw = new PrintWriter(os);
      pw.println("   [GanttBarStyleException");
      pw.println("      TaskID=" + m_taskUniqueID);
      pw.println("      BarStyleIndex=" + m_barStyleIndex);
      pw.println(super.toString());
      pw.println("   ]");
      pw.flush();
      return (os.toString());
   }

   private int m_taskUniqueID;
   private int m_barStyleIndex;
}