src2/net/miginfocom/layout/LayoutCallback.java

   1 package net.miginfocom.layout;
   2
   3 /*
   4  * License (BSD):
   5  * ==============
   6  *
   7  * Copyright (c) 2004, Mikael Grev, MiG InfoCom AB. (miglayout (at) miginfocom (dot) com)
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without modification,
  11  * are permitted provided that the following conditions are met:
  12  * Redistributions of source code must retain the above copyright notice, this list
  13  * of conditions and the following disclaimer.
  14  * Redistributions in binary form must reproduce the above copyright notice, this
  15  * list of conditions and the following disclaimer in the documentation and/or other
  16  * materials provided with the distribution.
  17  * Neither the name of the MiG InfoCom AB nor the names of its contributors may be
  18  * used to endorse or promote products derived from this software without specific
  19  * prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  23  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24  * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  27  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  30  * OF SUCH DAMAGE.
  31  *
  32  * @version 1.0
  33  * @author Mikael Grev, MiG InfoCom AB
  34  *         Date: 2006-sep-08
  35  */
  36
  37 /** A class to extend if you want to provide more control over where a component is placed or the size of it.
  38  * <p>
  39  * Note! Returned arrays from this class will never be altered. This means that caching of arrays in these methods
  40  * is OK.
  41  */
  42 public abstract class LayoutCallback
  43 {
  44         /** Returns a position similar to the "pos" the component constraint.
  45          * @param comp The component wrapper that holds the actual component (JComponent is Swing and Control in SWT).
  46          * <b>Should not be altered.</b>
  47          * @return The [x, y, x2, y2] as explained in the documentation for "pos". If <code>null</code>
  48          * is returned nothing is done and this is the default.
  49          * @see UnitValue
  50          * @see net.miginfocom.layout.ConstraintParser#parseUnitValue(String, boolean)
  51          */
  52         public UnitValue[] getPosition(ComponentWrapper comp)
  53         {
  54                 return null;
  55         }
  56
  57         /** Returns a size similar to the "width" and "height" in the component constraint.
  58          * @param comp The component wrapper that holds the actual component (JComponent is Swing and Control in SWT).
  59          * <b>Should not be altered.</b>
  60          * @return The [width, height] as explained in the documentation for "width" and "height". If <code>null</code>
  61          * is returned nothing is done and this is the default.
  62          * @see net.miginfocom.layout.BoundSize
  63          * @see net.miginfocom.layout.ConstraintParser#parseBoundSize(String, boolean, boolean)
  64          */
  65         public BoundSize[] getSize(ComponentWrapper comp)
  66         {
  67                 return null;
  68         }
  69
  70         /** A last minute change of the bounds. The bound for the layout cycle has been set and you can correct there
  71          * after any set of rules you like.
  72          * @param comp The component wrapper that holds the actual component (JComponent is Swing and Control in SWT).
  73          */
  74         public void correctBounds(ComponentWrapper comp)
  75         {
  76         }
  77 }