org.metawidget.swing.Stub Maven / Gradle / Ivy
// Metawidget (licensed under LGPL)
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package org.metawidget.swing;
import java.util.Map;
import javax.swing.BoxLayout;
import javax.swing.JComponent;
import org.metawidget.util.CollectionUtils;
/**
* Stub for Swing environments.
*
* Stubs are used to 'stub out' what Metawidget would normally create - either to suppress widget
* creation entirely or to create child widgets with a different name. They differ from Facets in
* that Facets are simply 'decorations' (such as button bars) to be recognized and arranged at the
* discretion of the Layout.
*
* We define separate Stub widgets, as opposed to simply a SwingMetawidget.addStub
* method, as this is more amenable to visual UI builders.
*
* @author Richard Kennard
*/
// Note: Stub extends JComponent, not JPanel, because in general it should not be opaque
//
public class Stub
extends JComponent {
//
// Private members
//
private Map mAttributes;
//
// Constructors
//
public Stub() {
// Default to BoxLayout, so that the controls fill the Stub width-ways. This
// is important for things like JTabbedPaneLayout
setLayout( new BoxLayout( this, BoxLayout.PAGE_AXIS ) );
}
/**
* Convenience constructor.
*
* Useful for creating stubs that will otherwise be empty, such as
* metawidget.add( new Stub( "foo" ))
*/
public Stub( String name ) {
setName( name );
}
//
// Public methods
//
public void setAttribute( String name, String value ) {
if ( mAttributes == null ) {
mAttributes = CollectionUtils.newHashMap();
}
mAttributes.put( name, value );
}
public Map getAttributes() {
return mAttributes;
}
}