org.metawidget.statically.BaseStaticWidget Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metawidget-all
The newest version!
// Metawidget
//
// This file is dual licensed under both the LGPL
// (http://www.gnu.org/licenses/lgpl-2.1.html) and the EPL
// (http://www.eclipse.org/org/documents/epl-v10.php). As a
// recipient of Metawidget, you may choose to receive it under either
// the LGPL or the EPL.
//
// Commercial licenses are also available. See http://metawidget.org
// for details.

package org.metawidget.statically;

import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;

import org.metawidget.iface.MetawidgetException;
import org.metawidget.util.CollectionUtils;

/**
 * @author Richard Kennard
 */

public abstract class BaseStaticWidget
	implements StaticWidget {

	//
	// Private methods
	//

	private StaticWidget		mParent;

	private List	mChildren	= new ArrayList() {

												@Override
												public void add( int index, StaticWidget element ) {

													if ( element instanceof BaseStaticWidget ) {
														( (BaseStaticWidget) element ).setParent( BaseStaticWidget.this );
													}

													super.add( index, element );
												}

												@Override
												public StaticWidget set( int index, StaticWidget element ) {

													if ( element instanceof BaseStaticWidget ) {
														( (BaseStaticWidget) element ).setParent( BaseStaticWidget.this );
													}

													StaticWidget previousElement = super.set( index, element );

													if ( previousElement instanceof BaseStaticWidget ) {
														( (BaseStaticWidget) previousElement ).setParent( null );
													}

													return previousElement;
												}

												@Override
												public boolean add( StaticWidget element ) {

													if ( element instanceof BaseStaticWidget ) {
														( (BaseStaticWidget) element ).setParent( BaseStaticWidget.this );
													}

													return super.add( element );
												}

												@Override
												public boolean addAll( Collection c ) {

													for( StaticWidget element : c ) {
														if ( element instanceof BaseStaticWidget ) {
															( (BaseStaticWidget) element ).setParent( BaseStaticWidget.this );
														}
													}

													return super.addAll( c );
												}

												@Override
												public boolean addAll( int index, Collection c ) {

													for( StaticWidget element : c ) {
														if ( element instanceof BaseStaticWidget ) {
															( (BaseStaticWidget) element ).setParent( BaseStaticWidget.this );
														}
													}

													return super.addAll( index, c );
												}
											};

	private Map	mClientProperties;

	//
	// Methods
	//

	public List getChildren() {

		return mChildren;
	}

	public StaticWidget getParent() {

		return mParent;
	}

	public void write( Writer writer )
		throws IOException {

		for ( StaticWidget child : mChildren ) {
			child.write( writer );
		}
	}

	/**
	 * General storage area, like JComponent.putClientProperty.
	 */

	public void putClientProperty( Object key, Object value ) {

		if ( mClientProperties == null ) {
			mClientProperties = CollectionUtils.newHashMap();
		}

		mClientProperties.put( key, value );
	}

	/**
	 * General storage area, like JComponent.putClientProperty.
	 */

	@SuppressWarnings( "unchecked" )
	public  T getClientProperty( Object key ) {

		if ( mClientProperties == null ) {
			return null;
		}

		return (T) mClientProperties.get( key );
	}

	@Override
	public String toString() {

		try {
			StringWriter writer = new StringWriter();
			write( writer );
			return writer.toString();
		} catch ( IOException e ) {
			throw MetawidgetException.newException( e );
		}
	}

	//
	// Private methods
	//

	/*package private*/ void setParent( StaticWidget widget ) {

		mParent = widget;
	}
}