Files
mono/mcs/class/System.Web/System.Web.UI/Control.cs
T
Bob Smith f417e9e65d More implementations.
svn path=/trunk/mcs/; revision=565
2001-08-22 16:07:36 +00:00

334 lines
13 KiB
C#

//
// System.Web.UI.Control.cs
//
// Author:
// Bob Smith <[email protected]>
//
// (C) Bob Smith
//
//notes: view state only tracks changes after OnInit method is executed for the page request. You can read from it at any time, but cant write to it during rendering.
//more notes: look at the private on* methods for initialization order. they will help.
//even more notes: view state info in trackviewstate method description. read later.
//Ok, enough notes: what the heck is different between enable view state, and track view state.
//cycle:
//init is called when control is first created.
//load is called when control is loaded into a page
//prerender is called when the server is about to render its page object
//disposed/unload not sure but is last.
//read this later. http://gotdotnet.com/quickstart/aspplus/
using System;
using System.Web;
using System.ComponentModel;
namespace System.Web.UI
{
public class Control : IComponent, IDisposable, IParserAccessor, IDataBindingsAccessor
{
public event EventHandler DataBinding;
public event EventHandler Disposed;
public event EventHandler Init;
public event EventHandler Load;
public event EventHandler PreRender;
public event EventHandler Unload;
private string _clientId; //default to "ctrl#" where # is a static count of ctrls per page.
private string _userId = null;
private ControlCollection _controls;
private bool _enableViewState = true;
private Control _namingContainer;
private Page _page;
private Control _parent; //TODO: set default.
private ISite _site; //TODO: what default?
private bool _visible; //TODO: what default?
private HttpContext _context = null;
private bool _childControlsCreated = false;
private StateBag _viewState; //TODO: help me.
private bool _trackViewState = false; //TODO: I think this is right. Verify. Also modify other methods to use this.
private bool _viewStateIgnoreCase = true;
public Control()
{
_namingContainer = _parent;
_viewState = new StateBag(_viewStateIgnoreCase);
_events = new EventHandlerList();
_controls = this.CreateControlCollection(); //FIXME: this goes here?
}
public ~Control()
{
Dispose();
}
public virtual string ClientID
{
get
{
return _clientId;
}
}
public virtual ControlCollection Controls
{
get
{
return _controls;
}
}
public virtual bool EnableViewState
{
get
{
return _enableViewState;
}
set
{
_enableViewState = value;
}
}
public virtual string ID
{
get
{
if (_userId == null)
return _clientId;
else
return _userId;
}
set
{
_userId = value;
}
}
public virtual Control NamingContainer
{
get
{
return _namingContainer;
}
}
public virtual Page Page
{
get
{
return _page;
}
set
{
_page = value;
}
}
public virtual Control Parent
{
get
{
return _parent;
}
}
public ISite Site
{
get
{
return _site;
}
set
{
_site = value;
}
}
public virtual string TemplateSourceDirectory
{
get
{
return Context.Request.ApplicationPath;
}
}
public virtual string UniqueID
{
get
{
if (_namingContainer == null)
if (_userId == null)
return _clientId;
else
return _clientId + ":" + _userId;
else if (_userId == null)
return _namingContainer.UniqueID + ":" + _clientId;
return _namingContainer.UniqueID + ":" + _clientId + ":" + _userId;
}
}
public virtual bool Visible
{
get
{
return _visible;
}
set
{
_visible = value;
}
}
protected bool ChildControlsCreated
{
get
{
return _childControlsCreated;
}
set
{
_childControlsCreated = value;
}
}
protected virtual HttpContext Context
{
get
{
HttpContext context;
if (_context != null)
return _context;
if (_parent == null)
return HttpContext.Current;
context = _parent.Context;
if (context != null)
return context;
return HttpContext.Current;
}
}
protected EventHandlerList Events
{
get
{
EventHandlerList e = new EventHandlerList();
e.AddHandler(this, DataBinding);
e.AddHandler(this, Disposed);
e.AddHandler(this, Init);
e.AddHandler(this, Load);
e.AddHandler(this, PreRender);
e.AddHandler(this, Unload);
return e;
}
}
protected bool HasChildViewState
{
get
{ //FIXME: Relook over this. not sure!
foreach (control c in _controls)
if (c.IsTrackingViewState) return true;
return false;
}
}
protected bool IsTrackingViewState
{
get
{ //FIXME: ME TO!
return _enableViewState;
}
}
protected virtual StateBag ViewState
{
get
{
return _viewState;
}
}
protected virtual bool ViewStateIgnoresCase
{
get
{
return _viewStateIgnoreCase;
}
}
protected virtual void AddParsedSubObject(object obj)
{
_controls.Add(obj);
}
protected void BuildProfileTree(string parentId, bool calcViewState)
{
//TODO
}
protected void ClearChildViewState()
{
//TODO
//Not quite sure about this. an example clears children then calls this, so I think
//view state is local to the current object, not children.
}
protected virtual void CreateChildControls() {}
protected virtual ControlCollection CreateControlCollection()
{
_controls = new ControlCollection(this);
}
protected virtual void EnsureChildControls() {} //FIXME: I think this should be empty.
public virtual Control FindControl(string id)
{
int i;
for (i = 0; i < _controls.Count; i++)
if (_controls[i].ID == id) return _controls[i].ID;
return null;
}
protected virtual Control FindControl(string id, int pathOffset)
{
int i;
for (i = pathOffset; i < _controls.Count; i++)
if (_controls[i].ID == id) return _controls[i].ID;
return null;
}
protected virtual void LoadViewState(object savedState)
{
//TODO: What should I do by default?
}
protected string MapPathSecure(string virtualPath)
{
//TODO: Need to read up on security+web.
}
protected virtual bool OnBubbleEvent(object source, EventArgs args)
{
return false; //FIXME: It might throw "ItemCommand". not sure.
}
protected virtual void OnDataBinding(EventArgs e)
{
if (DataBinding != null) DataBinding(this, e);
}
protected virtual void OnInit(EventArgs e)
{
if (Init != null) Init(this, e);
}
protected virtual void OnPreRender(EventArgs e)
{
if (PreRender != null) PreRender(this, e);
}
protected virtual void OnUnload(EventArgs e)
{
if (Unload != null) Unload(this, e);
}
protected void RaiseBubbleEvent(object source, EventArgs args)
{
_parent.OnBubbleEvent(source, args); //FIXME: I think this is right. Check though.
}
protected virtual void Render(HtmlTextWriter writer) {} //FIXME: Default?
protected virtual void RenderChildren(HtmlTextWriter writer)
{
//if render method delegate is set, call it here. otherwise,
//render any child controls. just a for loop?
}
protected virtual object SaveViewState()
{
return ViewState;
}
protected virtual void TrackViewState()
{
_trackViewState = true;
}
public virtual void DataBind()
{
//TODO: I think this recursively calls this method on its children.
}
public virtual void Dispose()
{
//TODO: nuke stuff.
if (Disposed != null) Disposed(this, e);
}
}
}