Welcome to mirror list, hosted at ThFree Co, Russian Federation.

NodeTypeAttribute.cs « Mono.Addins.Description « Mono.Addins - github.com/mono/mono-addins.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 149a401bc71f2ad893732a075e552360f5708454 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
//
// NodeTypeAttribute.cs
//
// Author:
//   Lluis Sanchez Gual
//
// Copyright (C) 2007 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.Xml;
using System.Collections.Specialized;
using Mono.Addins.Serialization;

namespace Mono.Addins.Description
{
	/// <summary>
	/// Description of the attribute of a node type.
	/// </summary>
	public sealed class NodeTypeAttribute: ObjectDescription
	{
		string name;
		string type;
		bool required;
		bool localizable;
		string description;
	
		/// <summary>
		/// Initializes a new instance of the <see cref="Mono.Addins.Description.NodeTypeAttribute"/> class.
		/// </summary>
		public NodeTypeAttribute()
		{
		}
		
		/// <summary>
		/// Copies data from another node attribute.
		/// </summary>
		/// <param name='att'>
		/// The attribute from which to copy.
		/// </param>
		public void CopyFrom (NodeTypeAttribute att)
		{
			name = att.name;
			type = att.type;
			required = att.required;
			localizable = att.localizable;
			description = att.description;
		}
		
		/// <summary>
		/// Gets or sets the name of the attribute.
		/// </summary>
		/// <value>
		/// The name.
		/// </value>
		public string Name {
			get { return name != null ? name : string.Empty; }
			set { name = value; }
		}
		
		/// <summary>
		/// Gets or sets a value indicating whether this <see cref="Mono.Addins.Description.NodeTypeAttribute"/> is required.
		/// </summary>
		/// <value>
		/// <c>true</c> if required; otherwise, <c>false</c>.
		/// </value>
		public bool Required {
			get { return required; }
			set { required = value; }
		}
		
		/// <summary>
		/// Gets or sets a value indicating whether this <see cref="Mono.Addins.Description.NodeTypeAttribute"/> is localizable.
		/// </summary>
		/// <value>
		/// <c>true</c> if localizable; otherwise, <c>false</c>.
		/// </value>
		public bool Localizable {
			get { return localizable; }
			set { localizable = value; }
		}
		
		/// <summary>
		/// Gets or sets the type of the attribute.
		/// </summary>
		/// <value>
		/// The type.
		/// </value>
		public string Type {
			get { return type != null ? type : string.Empty; }
			set { type = value; }
		}
		
		/// <summary>
		/// Gets or sets the description of the attribute.
		/// </summary>
		/// <value>
		/// The description.
		/// </value>
		public string Description {
			get { return description != null ? description : string.Empty; }
			set { description = value; }
		}
		
		/// <summary>
		/// Gets or sets the type of the content.
		/// </summary>
		/// <remarks>
		/// Allows specifying the type of the content of a string attribute.
		/// The value of this property is only informative, and it doesn't
		/// have any effect on how add-ins are packaged or loaded.
		/// </remarks>
		public ContentType ContentType { get; set; }
		
		internal override void Verify (string location, StringCollection errors)
		{
			VerifyNotEmpty (location + "Attribute", errors, Name, "name");
		}
		
		internal NodeTypeAttribute (XmlElement elem): base (elem)
		{
			name = elem.GetAttribute ("name");
			type = elem.GetAttribute ("type");
			required = elem.GetAttribute ("required").ToLower () == "true";
			localizable = elem.GetAttribute ("localizable").ToLower () == "true";
			string ct = elem.GetAttribute ("contentType");
			if (!string.IsNullOrEmpty (ct))
				ContentType = (ContentType) Enum.Parse (typeof(ContentType), ct);
			description = ReadXmlDescription ();
		}
		
		internal override void SaveXml (XmlElement parent)
		{
			CreateElement (parent, "Attribute");
			Element.SetAttribute ("name", name);

			if (Type.Length > 0)
				Element.SetAttribute ("type", Type);
			else
				Element.RemoveAttribute ("type");
			
			if (required)
				Element.SetAttribute ("required", "True");
			else
				Element.RemoveAttribute ("required");
			
			if (localizable)
				Element.SetAttribute ("localizable", "True");
			else
				Element.RemoveAttribute ("localizable");
			
			if (ContentType != ContentType.Text)
				Element.SetAttribute ("contentType", ContentType.ToString ());
			else
				Element.RemoveAttribute ("contentType");
			
			SaveXmlDescription (description);
		}
		
		internal override void Write (BinaryXmlWriter writer)
		{
			writer.WriteValue ("name", name);
			writer.WriteValue ("type", type);
			writer.WriteValue ("required", required);
			writer.WriteValue ("description", description);
			writer.WriteValue ("localizable", localizable);
			writer.WriteValue ("contentType", ContentType.ToString ());
		}
		
		internal override void Read (BinaryXmlReader reader)
		{
			name = reader.ReadStringValue ("name");
			type = reader.ReadStringValue ("type");
			required = reader.ReadBooleanValue ("required");
			if (!reader.IgnoreDescriptionData)
				description = reader.ReadStringValue ("description");
			localizable = reader.ReadBooleanValue ("localizable");
			string ct = reader.ReadStringValue ("contentType");
			try {
				ContentType = (ContentType) Enum.Parse (typeof(ContentType), ct);
			} catch {
				ContentType = ContentType.Text;
			}
		}
	}
}