mono/mcs/class/System/System.ComponentModel/Container.cs

//
// System.ComponentModel.Container.cs
//
// Author:
//  Miguel de Icaza ([email protected])
//  Andreas Nahr ([email protected])
//
// (C) Ximian, Inc.  http://www.ximian.com
// (C) 2003 Andreas Nahr
//

using System.Collections;

namespace System.ComponentModel {

	// <summary>
	//   Container class: encapsulates components.  
	// </summary>
	//
	// <remarks>
	//   
	// </remarks>
	public class Container : IContainer, IDisposable {

		private ArrayList c = new ArrayList ();
		//ComponentCollection cc;

		// <summary>
		//   Auxiliary class to support the default behaviour of CreateSite
		// </summary>
		//
		// <remarks>
		//   This is an internal class that is used to provide a
		//   default implementation of an ISite class.  Container
		//   is just a default implementation of IContainer, and
		//   provides this as a way of getting started
		// </remarks>
		
		class DefaultSite : ISite {
			private IComponent component;
			private IContainer container;
			private string     name;
			
			public DefaultSite (string name, IComponent component, IContainer container)
			{
				this.component = component;
				this.container = container;
				this.name = name;
			}

			public IComponent Component {
				get {
					return component;
				}
			}

			public IContainer Container {
				get {
					return container;
				}
			}

			[MonoTODO]
			public bool DesignMode {
				get {
					// FIXME: should we provide a way to set
					// this value?
					return false;
				}
			}

			public string Name {
				get {
					return name;
				}

				set {
					name = value;
				}
			}

			[MonoTODO]
			public virtual object GetService (Type t)
			{
				// FIXME: do not know what this is supposed to do.
				return null;
			}
		}
		
		// <summary>
		//   Container constructor
		// </summary>
		public Container ()
		{
		}

		public virtual ComponentCollection Components {
			get 
            {
                Array a = c.ToArray(typeof (IComponent));
				return new ComponentCollection((IComponent[]) a);
			}
		}

		// <summary>
		//   Adds an IComponent to the Container
		// </summary>
		public virtual void Add (IComponent component)
		{
			Add (component, null);
		}

		// <summary>
		//   Adds an IComponent to the Container.  With a name binding.
		// </summary>
		public virtual void Add (IComponent component, string name)
		{
			component.Site = CreateSite (component, name);
			c.Add (component);
		}

		// <summary>
		//   Returns an ISite for a component.
		// <summary>
		protected virtual ISite CreateSite (IComponent component, string name)
		{
			foreach (IComponent Comp in c) {
				if (Comp.Site != null)
				if (Comp.Site.Name == name)
					throw new ArgumentException ("duplicate component name", "name");
			}

			return new DefaultSite (name, component, this);
		}

		public void Dispose ()
		{
			Dispose (true);
			GC.SuppressFinalize (this);
		}

		bool disposed = false;
		
		protected virtual void Dispose (bool release_all)
		{
			if (disposed)
				return;
			disposed = true;

			if (release_all){
				//??
			}

			c = null;
		}

		~Container ()
		{
			Dispose (false);
		}

		[MonoTODO]
		protected virtual object GetService (Type service)
		{
			// FIXME: Not clear what GetService does.
			
			return null;
		}

		public virtual void Remove (IComponent component)
		{
			c.Remove (component);
		}
	}
	
}