src2/net/miginfocom/layout/InCellGapProvider.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 /** An interface to implement if you want to decide the gaps between two types of components within the same cell.
  38  * <p>
  39  * E.g.:
  40  *
  41  * <pre>
  42  * {@code
  43  * if (adjacentComp == null || adjacentSide == SwingConstants.LEFT || adjacentSide == SwingConstants.TOP)
  44  *        return null;
  45  *
  46  * boolean isHor = (adjacentSide == SwingConstants.LEFT || adjacentSide == SwingConstants.RIGHT);
  47  *
  48  * if (adjacentComp.getComponentType(false) == ComponentWrapper.TYPE_LABEL && comp.getComponentType(false) == ComponentWrapper.TYPE_TEXT_FIELD)
  49  *    return isHor ? UNRELATED_Y : UNRELATED_Y;
  50  *
  51  * return (adjacentSide == SwingConstants.LEFT || adjacentSide == SwingConstants.RIGHT) ? RELATED_X : RELATED_Y;
  52  * }
  53  * </pre>
  54  */
  55 public interface InCellGapProvider
  56 {
  57         /** Returns the default gap between two components that <b>are in the same cell</b>.
  58          * @param comp The component that the gap is for. Never <code>null</code>.
  59          * @param adjacentComp The adjacent component if any. May be <code>null</code>.
  60          * @param adjacentSide What side the <code>adjacentComp</code> is on. {@link javax.swing.SwingUtilities#TOP} or
  61          * {@link javax.swing.SwingUtilities#LEFT} or {@link javax.swing.SwingUtilities#BOTTOM} or {@link javax.swing.SwingUtilities#RIGHT}.
  62          * @param tag The tag string that the component might be tagged with in the component constraints. May be <code>null</code>.
  63          * @param isLTR If it is left-to-right.
  64          * @return The default gap between two components or <code>null</code> if there should be no gap.
  65          */
  66         public abstract BoundSize getDefaultGap(ComponentWrapper comp, ComponentWrapper adjacentComp, int adjacentSide, String tag, boolean isLTR);
  67 }