/* Copyright (c) 2006 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#region Using directives
#define USE_TRACING
using System;
using System.Xml;
using System.Globalization;
using System.ComponentModel;
using System.Runtime.InteropServices;
#endregion
//////////////////////////////////////////////////////////////////////
// contains AtomTextConstruct, the base class for all atom text representations
// atomPlainTextConstruct =
// atomCommonAttributes,
// attribute type { "text" | "html" }?,
// text
//
// atomXHTMLTextConstruct =
// atomCommonAttributes,
// attribute type { "xhtml" },
// xhtmlDiv
//
// atomTextConstruct = atomPlainTextConstruct | atomXHTMLTextConstruct
//////////////////////////////////////////////////////////////////////
namespace Google.GData.Client{
/// <summary>enum to define the AtomTextConstructs Type...</summary>
public enum AtomTextConstructElementType
{
/// <summary>this is a Right element</summary>
Rights,
/// <summary>this is a title element</summary>
Title,
/// <summary>this is a subtitle element</summary>
Subtitle,
/// <summary>this is a summary element</summary>
Summary,
}
/// <summary>enum to define the AtomTextConstructs Type...</summary>
public enum AtomTextConstructType
{
/// <summary>defines standard text</summary>
text,
/// <summary>defines html text</summary>
html,
/// <summary>defines xhtml text</summary>
xhtml
}
//////////////////////////////////////////////////////////////////////
/// <summary>TypeConverter, so that AtomTextConstruct shows up in the property pages
/// </summary>
//////////////////////////////////////////////////////////////////////
[ComVisible(false)]
public class AtomTextConstructConverter : ExpandableObjectConverter
{
///<summary>Standard type converter method</summary>
public override bool CanConvertTo(ITypeDescriptorContext context, System.Type destinationType)
{
if (destinationType == typeof(AtomTextConstruct))
return true;
return base.CanConvertTo(context, destinationType);
}
///<summary>Standard type converter method</summary>
public override object ConvertTo(ITypeDescriptorContext context,CultureInfo culture, object value, System.Type destinationType)
{
AtomTextConstruct tc = value as AtomTextConstruct;
if (destinationType == typeof(System.String) && tc != null)
{
return tc.Type + ": " + tc.Text;
}
return base.ConvertTo(context, culture, value, destinationType);
}
}
/////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
/// <summary>AtomTextConstruct object representation
/// A Text construct contains human-readable text, usually in small quantities.
/// The content of Text constructs is Language-Sensitive.
/// </summary>
//////////////////////////////////////////////////////////////////////
[TypeConverterAttribute(typeof(AtomTextConstructConverter)), DescriptionAttribute("Expand to see details for this object.")]
public class AtomTextConstruct: AtomBase
{
/// <summary>holds the type of the text</summary>
private AtomTextConstructType type;
/// <summary>holds the text as string</summary>
private string text;
/// <summary>holds the element type</summary>
private AtomTextConstructElementType elementType;
/// <summary>the public constructor only exists for the pleasure of property pages</summary>
public AtomTextConstruct()
{
}
//////////////////////////////////////////////////////////////////////
/// <summary>constructor indicating the elementtype</summary>
/// <param name="elementType">holds the xml elementype</param>
//////////////////////////////////////////////////////////////////////
public AtomTextConstruct(AtomTextConstructElementType elementType)
{
this.elementType = elementType;
this.type = AtomTextConstructType.text; // set the default to text
}
//////////////////////////////////////////////////////////////////////
/// <summary>constructor indicating the elementtype</summary>
/// <param name="elementType">holds the xml elementype</param>
/// <param name="text">holds the text string</param>
//////////////////////////////////////////////////////////////////////
public AtomTextConstruct(AtomTextConstructElementType elementType, string text) : this(elementType)
{
this.text = text;
}
/////////////////////////////////////////////////////////////////////////////
//
//
//////////////////////////////////////////////////////////////////////
/// <summary>accessor method public AtomTextConstructType Type</summary>
/// <returns> </returns>
//////////////////////////////////////////////////////////////////////
public AtomTextConstructType Type
{
get {return this.type;}
set {this.Dirty = true; this.type = value;}
}
/////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
/// <summary>accessor method public string Text</summary>
/// <returns> </returns>
//////////////////////////////////////////////////////////////////////
public string Text
{
get {return this.text;}
set {this.Dirty = true; this.text = value;}
}
/////////////////////////////////////////////////////////////////////////////
#region Persistence overloads
//////////////////////////////////////////////////////////////////////
/// <summary>Returns the constant representing this XML element.</summary>
//////////////////////////////////////////////////////////////////////
public override string XmlName
{
get
{
switch (this.elementType)
{
case AtomTextConstructElementType.Rights:
return AtomParserNameTable.XmlRightsElement;
case AtomTextConstructElementType.Subtitle:
return AtomParserNameTable.XmlSubtitleElement;
case AtomTextConstructElementType.Title:
return AtomParserNameTable.XmlTitleElement;
case AtomTextConstructElementType.Summary:
return AtomParserNameTable.XmlSummaryElement;
}
return null;
}
}
/////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
/// <summary>overridden to save attributes for this(XmlWriter writer)</summary>
/// <param name="writer">the xmlwriter to save into </param>
//////////////////////////////////////////////////////////////////////
protected override void SaveXmlAttributes(XmlWriter writer)
{
base.SaveXmlAttributes(writer);
WriteEncodedAttributeString(writer, AtomParserNameTable.XmlAttributeType, this.Type.ToString());
}
/////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
/// <summary>saves the inner state of the element</summary>
/// <param name="writer">the xmlWriter to save into </param>
//////////////////////////////////////////////////////////////////////
protected override void SaveInnerXml(XmlWriter writer)
{
base.SaveInnerXml(writer);
WriteEncodedString(writer, this.text);
}
/////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////
/// <summary>figures out if this object should be persisted</summary>
/// <returns> true, if it's worth saving</returns>
//////////////////////////////////////////////////////////////////////
public override bool ShouldBePersisted()
{
if (base.ShouldBePersisted() == false)
{
return Utilities.IsPersistable(this.text);
}
return true;
}
/////////////////////////////////////////////////////////////////////////////
#endregion
}
/////////////////////////////////////////////////////////////////////////////
}
/////////////////////////////////////////////////////////////////////////////
|