001: /*
002: *
003: *
004: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: */
026:
027: package javax.microedition.lcdui;
028:
029: import java.lang.IllegalArgumentException;
030:
031: /**
032: * A blank, non-interactive item that has a settable minimum size. The
033: * minimum width is useful for allocating flexible amounts of space between
034: * <code>Items</code> within the same row of a
035: * <code>Form</code>. The minimum height is useful for
036: * enforcing a particular minimum height of a row. The application can set
037: * the minimum width or height to any non-negative value. The implementation
038: * may enforce implementation-defined maximum values for the minimum width and
039: * height.
040: *
041: * <p>The unlocked preferred width of a <code>Spacer</code> is the same as its
042: * current minimum width. Its unlocked preferred height is the same as its
043: * current minimum height.</p>
044: *
045: * <p>Since a <code>Spacer's</code> primary purpose is to position
046: * other items, it is
047: * restricted to be non-interactive, and the application is not allowed to add
048: * <code>Commands</code> to a <code>Spacer</code>. Since the
049: * presence of a label on an <code>Item</code> may affect
050: * layout in device-specific ways, the label of a
051: * <code>Spacer</code> is restricted to
052: * always be <code>null</code>, and the application is not allowed
053: * to change it.</p>
054: *
055: */
056:
057: public class Spacer extends Item {
058:
059: /**
060: * Creates a new <code>Spacer</code> with the given minimum
061: * size. The <code>Spacer's</code> label
062: * is <code>null</code>.
063: * The minimum size must be zero or greater.
064: * If <code>minWidth</code> is greater than the
065: * implementation-defined maximum width, the maximum
066: * width will be used instead.
067: * If <code>minHeight</code> is greater than the
068: * implementation-defined maximum height, the maximum
069: * height will be used instead.
070: *
071: * @param minWidth the minimum width in pixels
072: * @param minHeight the minimum height in pixels
073: * @throws IllegalArgumentException if either <code>minWidth</code>
074: * or <code>minHeight</code> is less than zero
075: */
076: public Spacer(int minWidth, int minHeight) {
077: super (null);
078:
079: if (minWidth < 0 || minHeight < 0) {
080: throw new IllegalArgumentException();
081: }
082:
083: synchronized (Display.LCDUILock) {
084: width = minWidth;
085: height = minHeight;
086:
087: itemLF = spacerLF = LFFactory.getFactory()
088: .getSpacerLF(this );
089: }
090: }
091:
092: /**
093: * Sets the minimum size for this spacer. The
094: * <code>Form</code> will not
095: * be allowed to make the item smaller than this size.
096: * The minimum size must be zero or greater.
097: * If <code>minWidth</code> is greater than the
098: * implementation-defined maximum width, the maximum
099: * width will be used instead.
100: * If <code>minHeight</code> is greater than the
101: * implementation-defined maximum height, the maximum
102: * height will be used instead.
103: *
104: * @param minWidth the minimum width in pixels
105: * @param minHeight the minimum height in pixels
106: * @throws IllegalArgumentException if either <code>minWidth</code>
107: * or <code>minHeight</code> is less than zero
108: */
109: public void setMinimumSize(int minWidth, int minHeight) {
110: if (minWidth < 0 || minHeight < 0) {
111: throw new IllegalArgumentException();
112: }
113:
114: synchronized (Display.LCDUILock) {
115: width = minWidth;
116: height = minHeight;
117:
118: spacerLF.lSetMinimumSize(minWidth, minHeight);
119: }
120: }
121:
122: /**
123: * <code>Spacers</code> are restricted from having
124: * <code>Commands</code>, so this method will always
125: * throw <code>IllegalStateException</code> whenever it is called.
126: *
127: * @param cmd the <code>Command</code>
128: *
129: * @throws IllegalStateException always
130: */
131: public void addCommand(Command cmd) {
132: throw new IllegalStateException();
133: }
134:
135: /**
136: * Spacers are restricted from having <code>Commands</code>,
137: * so this method will always
138: * throw <code>IllegalStateException</code> whenever it is called.
139: *
140: * @param cmd the <code>Command</code>
141: *
142: * @throws IllegalStateException always
143: */
144: public void setDefaultCommand(Command cmd) {
145: throw new IllegalStateException();
146: }
147:
148: /**
149: * <code>Spacers</code> are restricted to having
150: * <code>null</code> labels, so this method will
151: * always throw
152: * <code>IllegalStateException</code> whenever it is called.
153: *
154: * @param label the label string
155: *
156: * @throws IllegalStateException always
157: */
158: public void setLabel(String label) {
159: throw new IllegalStateException();
160: }
161:
162: /** Spacer Look & Feel associated with this Spacer */
163: SpacerLF spacerLF;
164:
165: /** The preferred (and minimum) width of this Spacer */
166: int width;
167:
168: /** The preferred (and minimum) height of this Spacer */
169: int height;
170:
171: }
|