Files
mono/mcs/class/System.Web/System.Web.UI.WebControls/ListControl.cs
T
Igor Zelmanovich 460b7aac96 * ListControl.cs:
VewState saving and restoring rolled back to 1.1 implementation 
	(fixed corresponding test), corrected public interface (there are no 
	overriden methods SaveControlState, LoadControlState and OnInit), 
	implemented CausesValidation and ValidationGroup properties.

svn path=/trunk/mcs/; revision=65579
2006-09-18 14:19:21 +00:00

565 lines
13 KiB
C#

//
// System.Web.UI.WebControls.ListControl.cs
//
// Authors:
// Jackson Harper ([email protected])
//
// (C) 2005 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.Drawing;
using System.Web.Util;
using System.Collections;
using System.Globalization;
using System.ComponentModel;
using System.Collections.Specialized;
namespace System.Web.UI.WebControls {
[DataBindingHandler("System.Web.UI.Design.WebControls.ListControlDataBindingHandler, " + Consts.AssemblySystem_Design)]
[DefaultEventAttribute ("SelectedIndexChanged")]
#if !NET_2_0
[DefaultPropertyAttribute ("DataSource")]
#endif
[Designer("System.Web.UI.Design.WebControls.ListControlDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
[ParseChildrenAttribute (true, "Items")]
#if NET_2_0
[ControlValueProperty ("SelectedValue", null)]
#endif
public abstract class ListControl :
#if NET_2_0
DataBoundControl, IEditableTextControl, ITextControl
#else
WebControl
#endif
{
private static readonly object SelectedIndexChangedEvent = new object ();
#if NET_2_0
private static readonly object TextChangedEvent = new object ();
#endif
private ListItemCollection items;
int saved_selected_index = -2;
string saved_selected_value;
public ListControl () : base (HtmlTextWriterTag.Select)
{
}
#if NET_2_0
[DefaultValue (false)]
[Themeable (false)]
[MonoTODO]
[WebSysDescription ("")]
[WebCategory ("Behavior")]
public virtual bool AppendDataBoundItems
{
get {
return ViewState.GetBool ("AppendDataBoundItems", false);
}
set {
ViewState ["AppendDataBoundItems"] = value;
}
}
#endif
#if NET_2_0
[Themeable (false)]
#endif
[DefaultValue(false)]
[WebSysDescription ("")]
[WebCategory ("Behavior")]
public virtual bool AutoPostBack {
get { return ViewState.GetBool ("AutoPostBack", false); }
set { ViewState ["AutoPostBack"] = value; }
}
#if ONLY_1_1
[DefaultValue("")]
[WebSysDescription ("")]
[WebCategory ("Data")]
public virtual string DataMember {
get { return ViewState.GetString ("DataMember", String.Empty); }
set { ViewState ["DataMember"] = value; }
}
private object data_source;
[Bindable(true)]
[DefaultValue(null)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
[WebSysDescription ("")]
[WebCategory ("Data")]
public virtual object DataSource {
get { return data_source; }
set {
if(value == null || value is IListSource || value is IEnumerable) {
data_source = value;
return;
}
throw new ArgumentException("Invalid DataSource Type");
}
}
#endif
#if NET_2_0
[Themeable (false)]
#endif
[DefaultValue("")]
[WebSysDescription ("")]
[WebCategory ("Data")]
public virtual string DataTextField {
get { return ViewState.GetString ("DataTextField", String.Empty); }
set { ViewState ["DataTextField"] = value; }
}
#if NET_2_0
[Themeable (false)]
#endif
[DefaultValue("")]
[WebSysDescription ("")]
[WebCategory ("Data")]
public virtual string DataTextFormatString {
get { return ViewState.GetString ("DataTextFormatString", String.Empty); }
set { ViewState ["DataTextFormatString"] = value; }
}
#if NET_2_0
[Themeable (false)]
#endif
[DefaultValue("")]
[WebSysDescription ("")]
[WebCategory ("Data")]
public virtual string DataValueField {
get { return ViewState.GetString ("DataValueField", String.Empty); }
set { ViewState ["DataValueField"] = value; }
}
#if NET_2_0
[Editor ("System.Web.UI.Design.WebControls.ListItemsCollectionEditor," + Consts.AssemblySystem_Design, "System.Drawing.Design.UITypeEditor, " + Consts.AssemblySystem_Drawing)]
#endif
[DefaultValue(null)]
[MergableProperty(false)]
[PersistenceMode(PersistenceMode.InnerDefaultProperty)]
[WebSysDescription ("")]
[WebCategory ("Misc")]
public virtual ListItemCollection Items {
get {
if (items == null)
items = new ListItemCollection ();
return items;
}
}
// I can't find this info stored in the viewstate anywhere
// so it must be calculated on the fly.
[Bindable(true)]
[Browsable(false)]
[DefaultValue(0)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
#if NET_2_0
[Themeable (false)]
#endif
[WebSysDescription ("")]
[WebCategory ("Misc")]
public virtual int SelectedIndex {
get {
if (items == null)
return -1;
for (int i = 0; i < items.Count; i++) {
if (items [i].Selected)
return i;
}
return -1;
}
set {
if (items == null || items.Count == 0) {
// This will happen when assigning this property
// before DataBind () is called on the control.
saved_selected_index = value;
return;
}
if (value < -1 || value >= Items.Count)
throw new ArgumentOutOfRangeException ("value");
ClearSelection ();
if (value == -1)
return;
items [value].Selected = true;
/* you'd think this would be called, but noooo */
//OnSelectedIndexChanged (EventArgs.Empty);
}
}
[Browsable(false)]
[DefaultValue(null)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
[WebSysDescription ("")]
[WebCategory ("Misc")]
public virtual ListItem SelectedItem {
get {
int si = SelectedIndex;
if (si == -1)
return null;
return Items [si];
}
}
#if NET_2_0
[Bindable(true, BindingDirection.TwoWay)]
[Themeable (false)]
#else
[Bindable(true)]
#endif
[Browsable(false)]
[DefaultValue("")]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
[WebSysDescription ("")]
[WebCategory ("Misc")]
public virtual string SelectedValue {
get {
int si = SelectedIndex;
if (si == -1)
return String.Empty;
return Items [si].Value;
}
set {
ClearSelection ();
if (items == null || items.Count == 0) {
// This will happen when assigning this property
// before DataBind () is called on the control.
saved_selected_value = value;
return;
}
int count = Items.Count;
ListItemCollection coll = Items;
bool thr = true;
for (int i = 0; i < count; i++) {
if (coll [i].Value == value) {
coll [i].Selected = true;
thr = false;
}
}
if (thr) {
string msg = String.Format ("Argument value is out of range: {0}", value);
throw new ArgumentOutOfRangeException (msg);
}
}
}
#if NET_2_0
[Themeable (false)]
[DefaultValue ("")]
[DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
[Browsable (false)]
[MonoTODO]
[WebSysDescription ("")]
[WebCategoryAttribute ("Behavior")]
public virtual string Text {
get {
return SelectedValue;
}
set {
SelectedValue = value;
/* you'd think this would be called, but noooo */
//OnTextChanged (EventArgs.Empty);
}
}
#if HAVE_CONTROL_ADAPTERS
protected virtual new
#else
protected override
#endif
HtmlTextWriterTag TagKey
{
get {
return HtmlTextWriterTag.Select;
}
}
protected override void AddAttributesToRender (HtmlTextWriter w)
{
base.AddAttributesToRender (w);
}
#endif
public virtual void ClearSelection ()
{
if (items == null)
return;
int count = Items.Count;
for (int i = 0; i<count; i++)
items [i].Selected = false;
}
protected override void OnDataBinding (EventArgs e)
{
base.OnDataBinding (e);
IEnumerable list = DataSourceResolver.ResolveDataSource (DataSource, DataMember);
if (list == null)
return;
#if NET_2_0
if (!AppendDataBoundItems)
#endif
Items.Clear();
#if !NET_2_0
DoDataBinding (list);
#endif
if (saved_selected_value != null) {
SelectedValue = saved_selected_value;
if (saved_selected_index != -2 && saved_selected_index != SelectedIndex)
throw new ArgumentException ("SelectedIndex and SelectedValue are mutually exclusive.");
} else if (saved_selected_index != -2) {
SelectedIndex = saved_selected_index;
// No need to check saved_selected_value here, as it's done before.
}
}
#if NET_2_0
protected internal
#else
protected
#endif
override void OnPreRender (EventArgs e)
{
base.OnPreRender (e);
}
void DoDataBinding (IEnumerable dataSource)
{
if (dataSource != null) {
string format = DataTextFormatString;
if (format == "")
format = null;
string text_field = DataTextField;
string value_field = DataValueField;
ListItemCollection coll = Items;
foreach (object container in dataSource) {
string text;
string val;
text = val = null;
if (text_field != "") {
text = DataBinder.GetPropertyValue (container, text_field, format);
}
if (value_field != "") {
val = DataBinder.GetPropertyValue (container, value_field).ToString ();
} else if (text_field == "") {
text = val = container.ToString ();
if (format != null)
text = String.Format (format, container);
} else if (text != null) {
val = text;
}
if (text == null)
text = val;
coll.Add (new ListItem (text, val));
}
}
}
#if NET_2_0
protected virtual void OnTextChanged (EventArgs e)
{
EventHandler handler = (EventHandler) Events [TextChangedEvent];
if (handler != null)
handler (this, e);
}
protected internal override void PerformDataBinding (IEnumerable dataSource)
{
base.PerformDataBinding (dataSource);
DoDataBinding (dataSource);
}
[MonoTODO ("why override?")]
protected override void PerformSelect ()
{
base.PerformSelect ();
}
[MonoTODO]
protected internal override void RenderContents (HtmlTextWriter w)
{
base.RenderContents (w);
}
#endif
internal ArrayList GetSelectedIndicesInternal ()
{
ArrayList selected = null;
if (items != null) {
selected = new ArrayList ();
int count = Items.Count;
for (int i = 0; i < count; i++) {
if (items [i].Selected)
selected.Add (i);
}
}
return selected;
}
protected override object SaveViewState ()
{
object first = null;
object second = null;
first = base.SaveViewState ();
IStateManager manager = items as IStateManager;
if (manager != null)
second = manager.SaveViewState ();
ArrayList selected = GetSelectedIndicesInternal ();
if (first == null && second == null && selected == null)
return null;
return new Triplet (first, second, selected);
}
protected override void LoadViewState (object savedState)
{
object first = null;
object second = null;
ArrayList indices = null;
Triplet triplet = savedState as Triplet;
if (triplet != null) {
first = triplet.First;
second = triplet.Second;
indices = triplet.Third as ArrayList;
}
base.LoadViewState (first);
if (second != null) {
IStateManager manager = Items as IStateManager;
manager.LoadViewState (second);
}
if (indices != null) {
foreach (int index in indices)
Items [index].Selected = true;
}
}
#if NET_2_0
[MonoTODO]
protected void SetPostDataSelection (int selectedIndex)
{
throw new NotImplementedException ();
}
#endif
protected override void TrackViewState ()
{
base.TrackViewState ();
IStateManager manager = items as IStateManager;
if (manager != null)
manager.TrackViewState ();
}
protected virtual void OnSelectedIndexChanged (EventArgs e)
{
EventHandler handler = (EventHandler) Events [SelectedIndexChangedEvent];
if (handler != null)
handler (this, e);
}
#if NET_2_0
protected internal virtual void VerifyMultiSelect ()
{
}
#endif
[WebSysDescription ("")]
[WebCategory ("Action")]
public event EventHandler SelectedIndexChanged {
add { Events.AddHandler (SelectedIndexChangedEvent, value); }
remove { Events.RemoveHandler (SelectedIndexChangedEvent, value); }
}
#if NET_2_0
/* sealed in the docs */
public event EventHandler TextChanged {
add {
Events.AddHandler (TextChangedEvent, value);
}
remove {
Events.RemoveHandler (TextChangedEvent, value);
}
}
[Themeable (false)]
[DefaultValue (false)]
[WebSysDescription ("")]
[WebCategory ("Behavior")]
public virtual bool CausesValidation {
get {
return ViewState.GetBool ("CausesValidation", false);
}
set {
ViewState ["CausesValidation"] = value;
}
}
[Themeable (false)]
[DefaultValue ("")]
[WebSysDescription ("")]
[WebCategoryAttribute ("Behavior")]
public virtual string ValidationGroup {
get {
return ViewState.GetString ("ValidationGroup", "");
}
set {
ViewState ["ValidationGroup"] = value;
}
}
#endif
}
}