Files
mono/mcs/class/System.Web/System.Web.UI.WebControls/Repeater.cs
T
Sanja Gupta c07af6cb8a ChangeLog: Updated.
BaseDataList.cs:
DataBountControl.cs:
Repeater.cs: Added SelectArguments property and updated.
SiteMapDataSourceView.cs:
SqlDataSourceView.cs:
XmlDataSourceView.cs: Removed extra method, which was there to keep 
                      things compiling.


svn path=/trunk/mcs/; revision=36515
2004-11-25 04:20:53 +00:00

545 lines
14 KiB
C#

//
// System.Web.UI.WebControls.Repeater.cs
//
// Authors:
// Gaurav Vaish ([email protected])
// Gonzalo Paniagua Javier ([email protected])
// Andreas Nahr ([email protected])
// Sanjay Gupta ([email protected])
//
// (c) 2002 Ximian, Inc. (http://www.ximian.com)
// (C) Gaurav Vaish (2002)
// (C) 2003 Andreas Nahr
// (C) 2004 Novell, Inc. (http://www.novell.com)
//
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections;
using System.Web;
using System.Web.UI;
using System.Web.Util;
using System.ComponentModel;
using System.ComponentModel.Design;
namespace System.Web.UI.WebControls
{
[DefaultEvent("ItemCommand")]
[DefaultProperty("DataSource")]
[Designer ("System.Web.UI.Design.WebControls.RepeaterDesigner, " + Consts.AssemblySystem_Design, typeof (IDesigner))]
[ParseChildren(true)]
[PersistChildren(false)]
public class Repeater : Control, INamingContainer
{
private static readonly object ItemCommandEvent = new object();
private static readonly object ItemCreatedEvent = new object();
private static readonly object ItemDataBoundEvent = new object();
private static readonly string ITEMCOUNT = "Repeater_Item_Count";
private ITemplate alternatingItemTemplate;
private ITemplate footerTemplate;
private ITemplate headerTemplate;
private ITemplate itemTemplate;
private ITemplate separatorTemplate;
private object dataSource;
private RepeaterItemCollection items;
private ArrayList itemsArrayList;
public Repeater(): base()
{
}
[WebCategory ("Action")]
[WebSysDescription ("Raised when a command is executed in the DataList.")]
public event RepeaterCommandEventHandler ItemCommand
{
add
{
Events.AddHandler(ItemCommandEvent, value);
}
remove
{
Events.RemoveHandler(ItemCommandEvent, value);
}
}
[WebCategory ("Behavior")]
[WebSysDescription ("Raised when an item gets created.")]
public event RepeaterItemEventHandler ItemCreated
{
add
{
Events.AddHandler(ItemCreatedEvent, value);
}
remove
{
Events.RemoveHandler(ItemCreatedEvent, value);
}
}
[WebCategory ("Behavior")]
[WebSysDescription ("Raised when an item gets data-bound.")]
public event RepeaterItemEventHandler ItemDataBound
{
add
{
Events.AddHandler(ItemDataBoundEvent, value);
}
remove
{
Events.RemoveHandler(ItemDataBoundEvent, value);
}
}
[DefaultValue (null), Browsable (false), PersistenceMode (PersistenceMode.InnerProperty)]
[TemplateContainer (typeof (RepeaterItem))]
[WebSysDescription ("The template that is used to create an alternating item.")]
public virtual ITemplate AlternatingItemTemplate
{
get
{
return alternatingItemTemplate;
}
set
{
alternatingItemTemplate = value;
}
}
public override ControlCollection Controls
{
get
{
EnsureChildControls();
return base.Controls;
}
}
[DefaultValue (""), WebCategory ("Data")]
[WebSysDescription ("The name of the table that is used for binding when a DataSource is specified.")]
public virtual string DataMember
{
get
{
object o = ViewState["DataMember"];
if(o != null)
{
return (string)o;
}
return String.Empty;
}
set
{
ViewState["DataMember"] = value;
}
}
[DefaultValue (null), Bindable (true), WebCategory ("Data")]
[DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
[WebSysDescription ("The DataSource that is used for data-binding.")]
public virtual object DataSource
{
get
{
return dataSource;
}
set
{
if ((value!=null) && !(value is IListSource) && !(value is IEnumerable))
throw new ArgumentException ("An invalid data source is being used for " +
ID + ". A valid data source must implement either " +
"IListSource or IEnumerable.");
dataSource = value;
}
}
[DefaultValue (null), Browsable (false), PersistenceMode (PersistenceMode.InnerProperty)]
[TemplateContainer (typeof (RepeaterItem))]
[WebSysDescription ("The template that is used to create a footer.")]
public virtual ITemplate FooterTemplate
{
get
{
return footerTemplate;
}
set
{
footerTemplate = value;
}
}
[DefaultValue (null), Browsable (false), PersistenceMode (PersistenceMode.InnerProperty)]
[TemplateContainer (typeof (RepeaterItem))]
[WebSysDescription ("The template that is used to create a header.")]
public virtual ITemplate HeaderTemplate
{
get
{
return headerTemplate;
}
set
{
headerTemplate = value;
}
}
[Browsable (false)]
[DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
[WebSysDescription ("A collection containing all items.")]
public virtual RepeaterItemCollection Items
{
get
{
if(items == null)
{
if(itemsArrayList == null)
{
EnsureChildControls();
}
items = new RepeaterItemCollection(itemsArrayList);
}
return items;
}
}
[DefaultValue (null), Browsable (false), PersistenceMode (PersistenceMode.InnerProperty)]
[TemplateContainer (typeof (RepeaterItem))]
[WebSysDescription ("The template that is used to create an item.")]
public virtual ITemplate ItemTemplate
{
get
{
return itemTemplate;
}
set
{
itemTemplate = value;
}
}
[DefaultValue (null), Browsable (false), PersistenceMode (PersistenceMode.InnerProperty)]
[TemplateContainer (typeof (RepeaterItem))]
[WebSysDescription ("The template that is used to create a seperator.")]
public virtual ITemplate SeparatorTemplate
{
get
{
return separatorTemplate;
}
set
{
separatorTemplate = value;
}
}
public override void DataBind ()
{
#if NET_2_0
RequiresDataBinding = false;
#endif
OnDataBinding (EventArgs.Empty);
}
protected override void CreateChildControls()
{
Controls.Clear ();
if (ViewState[ITEMCOUNT] != null) {
CreateControlHierarchy (false);
} else {
itemsArrayList = new ArrayList ();
ClearChildViewState ();
}
}
private RepeaterItem CreateItem (int itemIndex,
ListItemType itemType,
bool dataBind,
object dataItem)
{
RepeaterItem repeaterItem = new RepeaterItem (itemIndex, itemType);
RepeaterItemEventArgs repeaterEventArgs = new RepeaterItemEventArgs (repeaterItem);
InstantiateItem (repeaterItem);
if (dataBind)
repeaterItem.DataItem = dataItem;
OnItemCreated (repeaterEventArgs);
Controls.Add (repeaterItem);
if (dataBind) {
repeaterItem.DataBind ();
OnItemDataBound (repeaterEventArgs);
repeaterItem.DataItem = null;
}
return repeaterItem;
}
private void InstantiateItem (RepeaterItem item)
{
ITemplate template;
switch (item.ItemType) {
case ListItemType.Header:
template = this.headerTemplate;
break;
case ListItemType.Footer:
template = this.footerTemplate;
break;
case ListItemType.Item:
template = this.itemTemplate;
break;
case ListItemType.AlternatingItem:
template = (alternatingItemTemplate != null ? this.alternatingItemTemplate : itemTemplate);
break;
case ListItemType.Separator:
template = this.separatorTemplate;
break;
default:
throw new HttpException ("Unknown ListItemType: " + item.ItemType);
}
if (template != null)
template.InstantiateIn (item);
}
protected virtual void CreateControlHierarchy (bool useDataSource)
{
if (itemsArrayList != null) {
itemsArrayList.Clear ();
} else {
itemsArrayList = new ArrayList ();
}
IEnumerable ds = null;
if (useDataSource) {
ds = GetResolvedDataSource ();
} else {
int itemCount = (int) ViewState [ITEMCOUNT];
if (itemCount != -1)
ds = new DataSourceInternal (itemCount);
}
int index = 0;
if (ds != null) {
if (headerTemplate != null)
CreateItem (-1, ListItemType.Header, useDataSource, null);
bool even = true;
foreach (object item in ds){
if (separatorTemplate != null && index > 0)
CreateItem (index - 1, ListItemType.Separator,
useDataSource, null);
RepeaterItem repeaterItem;
ListItemType lType;
if (!even)
lType = ListItemType.AlternatingItem;
else
lType = ListItemType.Item;
repeaterItem = CreateItem (index, lType, useDataSource, item);
itemsArrayList.Add (repeaterItem);
index++;
even = !even;
}
if (footerTemplate != null)
CreateItem (-1, ListItemType.Footer, useDataSource, null);
}
if (useDataSource)
ViewState [ITEMCOUNT] = (ds == null) ? -1 : index;
}
protected override bool OnBubbleEvent(object sender, EventArgs e)
{
bool retVal = false;
if(e is RepeaterCommandEventArgs)
{
OnItemCommand((RepeaterCommandEventArgs)e);
retVal = true;
}
return retVal;
}
protected override void OnDataBinding(EventArgs e)
{
base.OnDataBinding(e);
Controls.Clear();
ClearChildViewState();
CreateControlHierarchy(true);
ChildControlsCreated = true;
}
protected virtual void OnItemCommand(RepeaterCommandEventArgs e)
{
if(Events != null)
{
RepeaterCommandEventHandler rceh = (RepeaterCommandEventHandler)
Events [ItemCommandEvent];
if(rceh != null)
{
rceh(this, e);
}
}
}
protected virtual void OnItemCreated(RepeaterItemEventArgs e)
{
if(Events != null)
{
RepeaterItemEventHandler rceh = (RepeaterItemEventHandler)
Events [ItemCreatedEvent];
if(rceh != null)
{
rceh(this, e);
}
}
}
protected virtual void OnItemDataBound(RepeaterItemEventArgs e)
{
if(Events != null)
{
RepeaterItemEventHandler rceh = (RepeaterItemEventHandler)
Events [ItemDataBoundEvent];
if(rceh != null)
{
rceh(this, e);
}
}
}
protected virtual RepeaterItem CreateItem (int itemIndex, ListItemType itemType)
{
return new RepeaterItem (itemIndex, itemType);
}
protected virtual void InitializeItem (RepeaterItem item)
{
InstantiateItem (item);
}
#if NET_2_0
// should be `internal protected' (why, oh WHY did they do that !?!)
protected override void OnInit (EventArgs e)
{
base.OnInit(e);
inited = true;
if (!Page.IsPostBack)
RequiresDataBinding = true;
}
// should be `internal protected' (why, oh WHY did they do that !?!)
protected override void OnLoad (EventArgs e)
{
IDataSource ds = GetDataSourceObject () as IDataSource;
if (ds != null && DataSourceID != "")
ds.DataSourceChanged += new EventHandler (OnDataSourceChanged);
base.OnLoad(e);
}
// should be `internal protected' (why, oh WHY did they do that !?!)
protected override void OnPreRender (EventArgs e)
{
EnsureDataBound ();
base.OnPreRender (e);
}
protected void EnsureDataBound ()
{
if (RequiresDataBinding && DataSourceID != "")
DataBind ();
}
protected virtual object GetDataSourceObject ()
{
if (DataSourceID != "")
return (IDataSource) NamingContainer.FindControl (DataSourceID);
return DataSource;
}
protected virtual IEnumerable GetResolvedDataSource ()
{
if (DataSource != null && DataSourceID != "")
throw new HttpException ();
IDataSource ds = this.GetDataSourceObject () as IDataSource;
if (ds != null && DataSourceID != "")
return ds.GetView (DataMember).ExecuteSelect (selectArguments);
else if (DataSource != null)
return DataSourceHelper.GetResolvedDataSource (DataSource, DataMember);
else
return null;
}
protected void OnDataSourceChanged (object sender, EventArgs e)
{
RequiresDataBinding = true;
}
public virtual string DataSourceID {
get {
object o = ViewState ["DataSourceID"];
if (o != null)
return (string)o;
return String.Empty;
}
set {
if (inited)
RequiresDataBinding = true;
ViewState ["DataSourceID"] = value;
}
}
bool requiresDataBinding;
protected bool RequiresDataBinding {
get { return requiresDataBinding; }
set { requiresDataBinding = value; }
}
protected bool inited;
DataSourceSelectArguments selectArguments = null;
protected DataSourceSelectArguments SelectArguments {
get { return selectArguments; }
}
#else
IEnumerable GetResolvedDataSource ()
{
if (DataSource != null)
return DataSourceHelper.GetResolvedDataSource (DataSource, DataMember);
else
return null;
}
#endif
}
}