001: /*
002: * This file is part of the Tucana Echo2 Library.
003: * Copyright (C) 2006.
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 tucana.echo2.app.widgetdash;
031:
032: import nextapp.echo2.app.Component;
033:
034: /**
035: * A {@link Component} that wraps around a Widget. The WidgetContainer provides
036: * a title bar for the widget, and things such as close buttons and maximize
037: * buttons. This abstract class provides no UI.
038: *
039: * @author Jeremy Volkman
040: *
041: */
042: public abstract class WidgetContainer extends Component {
043:
044: /**
045: * Property key for this container's WidgetPosition
046: */
047: public static final String PROPERTY_POSITION = "widgetPosition";
048:
049: /**
050: * This container's WidgetIdentifier
051: */
052: protected WidgetIdentifier widgetIdentifier;
053:
054: /**
055: * Constructor.
056: *
057: * @param widgetIdentifier
058: * The WidgetIdentifier for this WidgetContainer. Must not be null.
059: */
060: public WidgetContainer(WidgetIdentifier widgetIdentifier) {
061: if (widgetIdentifier == null) {
062: throw new NullPointerException(
063: "widgetIdentifier cannot be null");
064: }
065: this .widgetIdentifier = widgetIdentifier;
066: }
067:
068: /**
069: * Returns the current title
070: *
071: * @return Title of the widget
072: */
073: public abstract String getTitle();
074:
075: /**
076: * Set the title of WidgetContainer
077: *
078: * @param iTitle
079: */
080: public abstract void setTitle(String iTitle);
081:
082: /**
083: * Return the body of this widget. This is the top layer component directly
084: * under the WidgetContainer
085: *
086: * @return The widget body.
087: */
088: public abstract Component getWidgetBody();
089:
090: /**
091: * Return the WidgetIdentifier associated with this widget
092: *
093: * @return The WidgetIdentifier
094: */
095: public WidgetIdentifier getWidgetIdentifier() {
096: return widgetIdentifier;
097: }
098:
099: /**
100: * Return this widget's position
101: *
102: * @return This widget's WidgetPosition, or null if it doesn't have one
103: */
104: public WidgetPosition getWidgetPosition() {
105: return (WidgetPosition) getProperty(PROPERTY_POSITION);
106: }
107:
108: /**
109: * Set this widget's position
110: *
111: * @param widgetPosition
112: * the new position
113: */
114: public void setWidgetPosition(WidgetPosition widgetPosition) {
115: setProperty(PROPERTY_POSITION, widgetPosition);
116: }
117:
118: @Override
119: public void processInput(String inputName, Object inputValue) {
120: if (PROPERTY_POSITION.equals(inputName)) {
121: setWidgetPosition((WidgetPosition) inputValue);
122: }
123: }
124: }
|