001: /*
002: * This file is part of the Echo Web Application Framework (hereinafter "Echo").
003: * Copyright (C) 2002-2005 NextApp, Inc.
004: *
005: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
006: *
007: * The contents of this file are subject to the Mozilla Public License Version
008: * 1.1 (the "License"); you may not use this file except in compliance with
009: * the License. You may obtain a copy of the License at
010: * http://www.mozilla.org/MPL/
011: *
012: * Software distributed under the License is distributed on an "AS IS" basis,
013: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
014: * for the specific language governing rights and limitations under the
015: * License.
016: *
017: * Alternatively, the contents of this file may be used under the terms of
018: * either the GNU General Public License Version 2 or later (the "GPL"), or
019: * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
020: * in which case the provisions of the GPL or the LGPL are applicable instead
021: * of those above. If you wish to allow use of your version of this file only
022: * under the terms of either the GPL or the LGPL, and not to allow others to
023: * use your version of this file under the terms of the MPL, indicate your
024: * decision by deleting the provisions above and replace them with the notice
025: * and other provisions required by the GPL or the LGPL. If you do not delete
026: * the provisions above, a recipient may use your version of this file under
027: * the terms of any one of the MPL, the GPL or the LGPL.
028: */
029:
030: package nextapp.echo2.app.layout;
031:
032: import nextapp.echo2.app.Alignment;
033: import nextapp.echo2.app.FillImage;
034: import nextapp.echo2.app.Color;
035: import nextapp.echo2.app.Extent;
036: import nextapp.echo2.app.Insets;
037: import nextapp.echo2.app.LayoutData;
038:
039: /**
040: * A <code>LayoutData</code> object used to describe how a
041: * <code>Component</code> is rendered within a <code>SplitPane</code>.
042: */
043: public class SplitPaneLayoutData implements LayoutData {
044:
045: public static final int OVERFLOW_AUTO = 0;
046: public static final int OVERFLOW_HIDDEN = 1;
047: public static final int OVERFLOW_SCROLL = 2;
048:
049: private int overflow;
050: private Alignment alignment;
051: private Color background;
052: private Extent maximumSize;
053: private Extent minimumSize;
054: private FillImage backgroundImage;
055: private Insets insets;
056:
057: /**
058: * Returns the alignment of the containing pane.
059: *
060: * @return the alignment
061: */
062: public Alignment getAlignment() {
063: return alignment;
064: }
065:
066: /**
067: * Returns the background color of the containing pane.
068: *
069: * @return the background color
070: */
071: public Color getBackground() {
072: return background;
073: }
074:
075: /**
076: * Returns the <code>BackgroundImage</code> displayed in the
077: * containing pane.
078: *
079: * @return the background image
080: */
081: public FillImage getBackgroundImage() {
082: return backgroundImage;
083: }
084:
085: /**
086: * Returns the inset margins of the containing pane.
087: * This property is not rendered when the <code>SplitPaneLayoutData</code>
088: * instance is attached to a <code>Pane</code> component.
089: *
090: * @return the inset margins
091: */
092: public Insets getInsets() {
093: return insets;
094: }
095:
096: /**
097: * Returns the preferred maximum size of the containing pane.
098: * This property only supports <code>Extent</code>s with
099: * pixel units.
100: *
101: * @return the maximum size
102: */
103: public Extent getMaximumSize() {
104: return maximumSize;
105: }
106:
107: /**
108: * Returns the preferred minimum size of the containing pane.
109: * This property only supports <code>Extent</code>s with
110: * pixel units.
111: *
112: * @return the minimum size
113: */
114: public Extent getMinimumSize() {
115: return minimumSize;
116: }
117:
118: /**
119: * Returns the overflow state, describing how the pane will behave when
120: * the content is larger than display area.
121: *
122: * @return the overflow state, one of the following values:
123: * <ul>
124: * <li><code>OVERFLOW_AUTO</code>: provide scrollbars as necessary</li>
125: * <li><code>OVERFLOW_HIDDEN</code>: never display scrollbars, hide overflow content</li>
126: * <li><code>OVERFLOW_SCROLL</code>: always display scrollbars</li>
127: * </ul>
128: */
129: public int getOverflow() {
130: return overflow;
131: }
132:
133: /**
134: * Sets the alignment of the containing pane.
135: *
136: * @param newValue the new alignment
137: */
138: public void setAlignment(Alignment newValue) {
139: alignment = newValue;
140: }
141:
142: /**
143: * Sets the background color of the containing pane.
144: *
145: * @param newValue the new background color
146: */
147: public void setBackground(Color newValue) {
148: background = newValue;
149: }
150:
151: /**
152: * Sets the <code>BackgroundImage</code> displayed in the
153: * containing pane.
154: *
155: * @param newValue the new <code>BackgroundImage</code>
156: */
157: public void setBackgroundImage(FillImage newValue) {
158: backgroundImage = newValue;
159: }
160:
161: /**
162: * Sets the inset margins of the containing pane.
163: * This property is not rendered when the <code>SplitPaneLayoutData</code>
164: * instance is attached to a <code>Pane</code> component.
165: *
166: * @param newValue the new inset margins
167: */
168: public void setInsets(Insets newValue) {
169: insets = newValue;
170: }
171:
172: /**
173: * Sets the preferred maximum size of the containing pane.
174: * This property only supports <code>Extent</code>s with
175: * pixel units.
176: *
177: * @param newValue the new maximum size
178: */
179: public void setMaximumSize(Extent newValue) {
180: maximumSize = newValue;
181: }
182:
183: /**
184: * Sets the preferred minimum size of the containing pane.
185: * This property only supports <code>Extent</code>s with
186: * pixel units.
187: *
188: * @param newValue the new minimum size
189: */
190: public void setMinimumSize(Extent newValue) {
191: minimumSize = newValue;
192: }
193:
194: /**
195: * Sets the overflow state, describing how the pane will behave when
196: * the content is larger than display area.
197: *
198: * @param newValue the overflow state, one of the following values:
199: * <ul>
200: * <li><code>OVERFLOW_AUTO</code>: provide scrollbars as necessary</li>
201: * <li><code>OVERFLOW_HIDDEN</code>: never display scrollbars, hide overflow content</li>
202: * <li><code>OVERFLOW_SCROLL</code>: always display scrollbars</li>
203: * </ul>
204: */
205: public void setOverflow(int newValue) {
206: overflow = newValue;
207: }
208: }
|