Source for javax.imageio.IIOParam

   1: /* IIOParam.java --
   2:    Copyright (C) 2004  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.imageio;
  40: 
  41: import java.awt.Point;
  42: import java.awt.Rectangle;
  43: 
  44: /**
  45:  * @author Michael Koch (konqueror@gmx.de)
  46:  */
  47: public abstract class IIOParam
  48: {
  49:   protected IIOParamController controller;
  50:   protected IIOParamController defaultController;
  51:   protected Point destinationOffset = new Point(0, 0);
  52:   protected ImageTypeSpecifier destinationType;
  53:   protected int[] sourceBands;
  54:   protected Rectangle sourceRegion;
  55:   protected int sourceXSubsampling;
  56:   protected int sourceYSubsampling;
  57:   protected int subsamplingXOffset;
  58:   protected int subsamplingYOffset;
  59: 
  60:   /**
  61:    * Initializes an <code>IIOParam</code> object.
  62:    */
  63:   protected IIOParam()
  64:   {
  65:     // Do nothing here.
  66:   }
  67: 
  68:   public boolean activateController()
  69:   {
  70:     if (controller == null)
  71:       return false;
  72:     
  73:     return controller.activate(this);
  74:   }
  75:   
  76:   public IIOParamController getController()
  77:   {
  78:     return controller;
  79:   }
  80: 
  81:   public IIOParamController getDefaultController()
  82:   {
  83:     return defaultController;
  84:   }
  85: 
  86:   public Point getDestinationOffset()
  87:   {
  88:     return destinationOffset;
  89:   }
  90: 
  91:   public ImageTypeSpecifier getDestinationType()
  92:   {
  93:     return destinationType;
  94:   }
  95: 
  96:   public int[] getSourceBands()
  97:   {
  98:     return sourceBands;
  99:   }
 100: 
 101:   public Rectangle getSourceRegion()
 102:   {
 103:     return sourceRegion;
 104:   }
 105: 
 106:   public int getSourceXSubsampling()
 107:   {
 108:     return sourceXSubsampling;
 109:   }
 110:   
 111:   public int getSourceYSubsampling()
 112:   {
 113:     return sourceYSubsampling;
 114:   }
 115: 
 116:   public int getSubsamplingXOffset()
 117:   {
 118:     return subsamplingXOffset;
 119:   }
 120:   
 121:   public int getSubsamplingYOffset()
 122:   {
 123:     return subsamplingYOffset;
 124:   }
 125: 
 126:   public boolean hasController()
 127:   {
 128:     return getController() != null;
 129:   }
 130: 
 131:   public void setController(IIOParamController controller)
 132:   {
 133:     this.controller = controller;
 134:   }
 135: 
 136:   public void setDestinationOffset(Point destinationOffset)
 137:   {
 138:     if (destinationOffset == null)
 139:       throw new IllegalArgumentException("destinationOffset is null");
 140: 
 141:     this.destinationOffset = destinationOffset;
 142:   }
 143: 
 144:   public void setSourceBands(int[] sourceBands)
 145:   {
 146:     this.sourceBands = sourceBands;
 147:   }
 148: 
 149:   public void setSourceRegion(Rectangle sourceRegion)
 150:   {
 151:     if (sourceRegion != null
 152:     && (sourceRegion.x < 0
 153:         || sourceRegion.y < 0
 154:         || sourceRegion.width <= 0
 155:         || sourceRegion.height <= 0))
 156:       throw new IllegalArgumentException("illegal source region");
 157:     
 158:     // FIXME: Throw IllegalStateException.
 159: 
 160:     this.sourceRegion = sourceRegion;
 161:   }
 162: 
 163:   public void setSourceSubsampling(int sourceXSubsampling, int sourceYSubsampling,
 164:                    int subsamplingXOffset, int subsamplingYOffset)
 165:   {
 166:     this.sourceXSubsampling = sourceXSubsampling;
 167:     this.sourceYSubsampling = sourceYSubsampling;
 168:     this.subsamplingXOffset = subsamplingXOffset;
 169:     this.subsamplingYOffset = subsamplingYOffset;
 170:   }
 171: }