com.hfg.xml.msofficexml.part.ImagePart 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.xml.msofficexml.part;


import com.hfg.graphics.units.GfxSize2D;
import com.hfg.image.ImageFormat;
import com.hfg.util.StringUtil;

import java.io.InputStream;

//------------------------------------------------------------------------------
/**
 Represents an Office Open XML image part.

 @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 ImagePart extends MediaPart
{
   private ImageFormat mImageFormat;
   private Float       mScalingFactor;

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

   //---------------------------------------------------------------------------
   public ImagePart(InputStream inStream, String inName)
   {
      super(inStream, inName);
   }

   //---------------------------------------------------------------------------
   public ImagePart(InputStream inStream, String inName, GfxSize2D inDimensions)
   {
      super(inStream, inName, inDimensions);
   }

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

   //---------------------------------------------------------------------------
   /**
    Specifies the scaling factor that was used (for informational purposes).
    * @param inValue the scaling factor used to adjust the displayed image size
    * @return this document part to enable method chaining.
    */
   public ImagePart setScalingFactor(float inValue)
   {
      mScalingFactor = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   /**
    Returns the scaling factor that was used (for informational purposes).
    * @return the scaling factor used to adjust the displayed image size
    */
   public Float getScalingFactor()
   {
      return mScalingFactor;
   }

   //###########################################################################
   // PRIVATE METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   private ImageFormat getImageFormat()
   {
      if (null == mImageFormat)
      {
         if (StringUtil.isSet(getFile().getName()))
         {
            mImageFormat = ImageFormat.guessFormatFromName(getFile().getName());
         }
      }

      return mImageFormat;
   }
}