001: /*
002: * Copyright (c) 2002-2004 JGoodies Karsten Lentzsch. All Rights Reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * o Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * o Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: *
014: * o Neither the name of JGoodies Karsten Lentzsch nor the names of
015: * its contributors may be used to endorse or promote products derived
016: * from this software without specific prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
020: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
021: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
022: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
023: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
025: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
026: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
027: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029: */
030:
031: package com.jgoodies.forms.util;
032:
033: import java.awt.Component;
034:
035: /**
036: * An interface that describes how to convert general sizes to pixel sizes. For
037: * example, <i>dialog units</i> require a conversion that honors the font and
038: * resolution. The {@link com.jgoodies.forms.layout.Sizes} class delegates all
039: * size conversions to an implementation of this interface.
040: *
041: * @author Karsten Lentzsch
042: * @version $Revision: 1.2 $
043: * @see com.jgoodies.forms.layout.Sizes
044: * @see com.jgoodies.forms.layout.ConstantSize
045: * @see AbstractUnitConverter
046: * @see DefaultUnitConverter
047: */
048: public interface UnitConverter {
049:
050: /**
051: * Converts Inches and returns pixels using the specified resolution.
052: *
053: * @param in
054: * the Inches
055: * @param component
056: * the component that provides the graphics object
057: * @return the given Inches as pixels
058: */
059: public int inchAsPixel(double in, Component component);
060:
061: /**
062: * Converts Millimeters and returns pixels using the resolution of the given
063: * component's graphics object.
064: *
065: * @param mm
066: * Millimeters
067: * @param component
068: * the component that provides the graphics object
069: * @return the given Millimeters as pixels
070: */
071: public int millimeterAsPixel(double mm, Component component);
072:
073: /**
074: * Converts Centimeters and returns pixels using the resolution of the given
075: * component's graphics object.
076: *
077: * @param cm
078: * Centimeters
079: * @param component
080: * the component that provides the graphics object
081: * @return the given Centimeters as pixels
082: */
083: public int centimeterAsPixel(double cm, Component component);
084:
085: /**
086: * Converts DTP Points and returns pixels using the resolution of the given
087: * component's graphics object.
088: *
089: * @param pt
090: * DTP Points
091: * @param component
092: * the component that provides the graphics object
093: * @return the given Points as pixels
094: */
095: public int pointAsPixel(int pt, Component component);
096:
097: /**
098: * Converts horizontal dialog units and returns pixels. Honors the
099: * resolution, dialog font size, platform and look&feel.
100: *
101: * @param dluX
102: * the horizontal dialog units
103: * @param component
104: * a component that provides the font and graphics
105: * @return the given horizontal dialog units as pixels
106: */
107: public int dialogUnitXAsPixel(int dluX, Component component);
108:
109: /**
110: * Converts vertical dialog units and returns pixels. Honors the resolution,
111: * dialog font size, platform and look&feel.
112: *
113: * @param dluY
114: * the vertical dialog units
115: * @param component
116: * a component that provides the font and graphics
117: * @return the given vertical dialog units as pixels
118: */
119: public int dialogUnitYAsPixel(int dluY, Component component);
120:
121: }
|