SvgText.cs 16.3 KB
Newer Older
davescriven's avatar
davescriven committed
1
2
3
using System;
using System.Collections.Generic;
using System.Text;
4
using System.Text.RegularExpressions;
davescriven's avatar
davescriven committed
5
6
7
8
using System.ComponentModel;
using System.Drawing;
using System.Drawing.Drawing2D;
using System.Drawing.Text;
9
10
using Svg.DataTypes;
using System.Linq;
davescriven's avatar
davescriven committed
11
12
13
14
15
16

namespace Svg
{
    /// <summary>
    /// The <see cref="SvgText"/> element defines a graphics element consisting of text.
    /// </summary>
17
    [SvgElement("text")]
18
    public class SvgText : SvgVisualElement
davescriven's avatar
davescriven committed
19
20
21
    {
        private SvgUnit _x;
        private SvgUnit _y;
22
23
        private SvgUnit _dy;
        private SvgUnit _dx;
davescriven's avatar
davescriven committed
24
25
        private SvgUnit _letterSpacing;
        private SvgUnit _wordSpacing;
26
        private FontData _fontData;
davescriven's avatar
davescriven committed
27
28
        private GraphicsPath _path;
        private SvgTextAnchor _textAnchor = SvgTextAnchor.Start;
29
        private static readonly SvgRenderer _stringMeasure;
samjudson's avatar
samjudson committed
30
31
        private const string DefaultFontFamily = "Times New Roman";

davescriven's avatar
davescriven committed
32
33
34
35
36
37
        /// <summary>
        /// Initializes the <see cref="SvgText"/> class.
        /// </summary>
        static SvgText()
        {
            Bitmap bitmap = new Bitmap(1, 1);
38
            _stringMeasure = SvgRenderer.FromImage(bitmap);
39
            _stringMeasure.TextRenderingHint = TextRenderingHint.AntiAlias;
davescriven's avatar
davescriven committed
40
41
42
43
44
45
46
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="SvgText"/> class.
        /// </summary>
        public SvgText()
        {
47
            this._fontData = new FontData();
48
49
            this._dy = new SvgUnit(0.0f);
            this._dx = new SvgUnit(0.0f);
davescriven's avatar
davescriven committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="SvgText"/> class.
        /// </summary>
        /// <param name="text">The text.</param>
        public SvgText(string text) : this()
        {
            this.Text = text;
        }

        /// <summary>
        /// Gets or sets the text to be rendered.
        /// </summary>
        public virtual string Text
        {
            get { return base.Content; }
Tebjan Halm's avatar
Tebjan Halm committed
67
            set { base.Content = value; this.IsPathDirty = true; this.Content = value; }
davescriven's avatar
davescriven committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
        }

        /// <summary>
        /// Gets or sets the text anchor.
        /// </summary>
        /// <value>The text anchor.</value>
        [SvgAttribute("text-anchor")]
        public virtual SvgTextAnchor TextAnchor
        {
            get { return this._textAnchor; }
            set { this._textAnchor = value; this.IsPathDirty = true; }
        }

        /// <summary>
        /// Gets or sets the X.
        /// </summary>
        /// <value>The X.</value>
        [SvgAttribute("x")]
        public virtual SvgUnit X
        {
88
89
90
91
92
93
94
95
96
97
        	get { return this._x; }
        	set
        	{
        		if(_x != value)
        		{
        			this._x = value;
        			this.IsPathDirty = true;
        			OnAttributeChanged(new AttributeEventArgs{ Attribute = "x", Value = value });
        		}
        	}
davescriven's avatar
davescriven committed
98
99
        }

100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
        /// <summary>
        /// Gets or sets the dX.
        /// </summary>
        /// <value>The dX.</value>
        [SvgAttribute("dx")]
        public virtual SvgUnit Dx
        {
            get { return this._dx; }
            set
            {
                if (_dx != value)
                {
                    this._dx = value;
                    this.IsPathDirty = true;
                    OnAttributeChanged(new AttributeEventArgs { Attribute = "dx", Value = value });
                }
            }
        }

davescriven's avatar
davescriven committed
119
120
121
122
123
124
125
        /// <summary>
        /// Gets or sets the Y.
        /// </summary>
        /// <value>The Y.</value>
        [SvgAttribute("y")]
        public virtual SvgUnit Y
        {
126
127
128
129
130
131
132
133
134
135
        	get { return this._y; }
        	set
        	{
        		if(_y != value)
        		{
        			this._y = value;
        			this.IsPathDirty = true;
        			OnAttributeChanged(new AttributeEventArgs{ Attribute = "y", Value = value });
        		}
        	}
davescriven's avatar
davescriven committed
136
137
        }

138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
        /// <summary>
        /// Gets or sets the dY.
        /// </summary>
        /// <value>The dY.</value>
        [SvgAttribute("dy")]
        public virtual SvgUnit Dy
        {
            get { return this._dy; }
            set
            {
                if (_dy != value)
                {
                    this._dy = value;
                    this.IsPathDirty = true;
                    OnAttributeChanged(new AttributeEventArgs { Attribute = "dy", Value = value });
                }
            }
        }

davescriven's avatar
davescriven committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
        /// <summary>
        /// Specifies spacing behavior between text characters.
        /// </summary>
        [SvgAttribute("letter-spacing")]
        public virtual SvgUnit LetterSpacing
        {
            get { return this._letterSpacing; }
            set { this._letterSpacing = value; this.IsPathDirty = true; }
        }

        /// <summary>
        /// Specifies spacing behavior between words.
        /// </summary>
        [SvgAttribute("word-spacing")]
        public virtual SvgUnit WordSpacing
        {
            get { return this._wordSpacing; }
            set { this._wordSpacing = value; this.IsPathDirty = true; }
        }

        /// <summary>
        /// Indicates which font family is to be used to render the text.
        /// </summary>
        [SvgAttribute("font-family")]
Tebjan Halm's avatar
Tebjan Halm committed
181
        public virtual string FontFamily
davescriven's avatar
davescriven committed
182
        {
183
184
            get { return this._fontData.FontFamily; }
            set { this._fontData.FontFamily = value; this.IsPathDirty = true; }
davescriven's avatar
davescriven committed
185
186
187
188
189
190
191
192
        }

        /// <summary>
        /// Refers to the size of the font from baseline to baseline when multiple lines of text are set solid in a multiline layout environment.
        /// </summary>
        [SvgAttribute("font-size")]
        public virtual SvgUnit FontSize
        {
193
194
            get { return this._fontData.FontSize; }
            set { this._fontData.FontSize = value; this.IsPathDirty = true; }
davescriven's avatar
davescriven committed
195
196
        }

197
198
199
200
201
202
203

		/// <summary>
		/// Refers to the boldness of the font.
		/// </summary>
		[SvgAttribute("font-weight")]
		public virtual SvgFontWeight FontWeight
		{
204
205
            get { return this._fontData.FontWeight; }
            set { this._fontData.FontWeight = value; this.IsPathDirty = true; }
206
207
208
		}


davescriven's avatar
davescriven committed
209
210
211
212
        /// <summary>
        /// Set all font information.
        /// </summary>
        [SvgAttribute("font")]
Tebjan Halm's avatar
Tebjan Halm committed
213
        public virtual string Font
davescriven's avatar
davescriven committed
214
        {
215
216
            get { return this._fontData.Font; }
            set { _fontData.Font = value; this.IsPathDirty = true; }
davescriven's avatar
davescriven committed
217
218
219
220
221
222
223
224
225
226
227
        }

        /// <summary>
        /// Gets or sets the fill.
        /// </summary>
        /// <remarks>
        /// <para>Unlike other <see cref="SvgGraphicsElement"/>s, <see cref="SvgText"/> has a default fill of black rather than transparent.</para>
        /// </remarks>
        /// <value>The fill.</value>
        public override SvgPaintServer Fill
        {
228
229
230
231
232
233
234
235
236
237
238
            get {
                var spans = this.Children.Where(x => x is SvgTextSpan).Select(x => x as SvgTextSpan).ToList();
                if (spans.Count == 1 && spans[0].Fill != SvgColourServer.NotSet)
                {
                    return spans[0].Fill;
                }
                else
                {
                    return (this.Attributes["fill"] == null) ? new SvgColourServer(Color.Black) : (SvgPaintServer)this.Attributes["fill"]; 
                }
            }
239
            set { this.Attributes["fill"] = value; }
davescriven's avatar
davescriven committed
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
        }

        /// <summary>
        /// Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
        /// </summary>
        /// <returns>
        /// A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
        /// </returns>
        public override string ToString()
        {
            return this.Text;
        }

        /// <summary>
        /// Gets or sets a value to determine if anti-aliasing should occur when the element is being rendered.
        /// </summary>
        /// <value></value>
        protected override bool RequiresSmoothRendering
        {
            get { return true; }
        }

        /// <summary>
        /// Gets the bounds of the element.
        /// </summary>
        /// <value>The bounds.</value>
        public override System.Drawing.RectangleF Bounds
        {
            get { return this.Path.GetBounds(); }
        }

Tebjan Halm's avatar
Tebjan Halm committed
271
        static private RectangleF MeasureString(SvgRenderer renderer, string text, Font font)
272
273
274
        {
            GraphicsPath p = new GraphicsPath();
            p.AddString(text, font.FontFamily, 0, font.Size, new PointF(0.0f, 0.0f), StringFormat.GenericTypographic);
275
            
276
            p.Transform(renderer.Transform);
Tebjan Halm's avatar
Tebjan Halm committed
277
            return p.GetBounds();
278
279
        }

davescriven's avatar
davescriven committed
280
281
282
283
284
285
286
287
288
        /// <summary>
        /// Gets the <see cref="GraphicsPath"/> for this element.
        /// </summary>
        /// <value></value>
        public override System.Drawing.Drawing2D.GraphicsPath Path
        {
            get
            {
                // Make sure the path is always null if there is no text
Mark Johnson's avatar
Mark Johnson committed
289
				//if there is a TSpan inside of this text element then path should not be null (even if this text is empty!)
Eric Domke's avatar
Eric Domke committed
290
				if ((string.IsNullOrEmpty(this.Text) || this.Text.Trim().Length < 1) && this.Children.Where(x => x is SvgTextSpan).Select(x => x as SvgTextSpan).Count() == 0)
291
				    return _path = null;
292
				//NOT SURE WHAT THIS IS ABOUT - Path gets created again anyway - WTF?
293
                // When an empty string is passed to GraphicsPath, it rises an InvalidArgumentException...
294
295

				if (_path == null || this.IsPathDirty)
davescriven's avatar
davescriven committed
296
                {
297
                    var font = this._fontData.GetFont(this, null);
davescriven's avatar
davescriven committed
298
299
300
301

                    _path = new GraphicsPath();
                    _path.StartFigure();

302
					if (!string.IsNullOrEmpty(this.Text))
303
	                	DrawString(_path, this.X, this.Y, this.Dx, this.Dy, font, this.Text);
davescriven's avatar
davescriven committed
304

305
306
					foreach (var tspan in this.Children.Where(x => x is SvgTextSpan).Select(x => x as SvgTextSpan))
					{
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
                        if (!string.IsNullOrEmpty(tspan.Text))
                        {
                            if (tspan.FontInfo.Equals(this._fontData))
                            {
                                DrawString(
                                    _path,
                                    tspan.X == SvgUnit.Empty ? this.X : tspan.X,
                                    tspan.Y == SvgUnit.Empty ? this.Y : tspan.Y,
                                    tspan.DX,
                                    tspan.DY,
                                    font,
                                    tspan.Text);
                            }
                            else
                            {
                                DrawString(
                                    _path,
                                    tspan.X == SvgUnit.Empty ? this.X : tspan.X,
                                    tspan.Y == SvgUnit.Empty ? this.Y : tspan.Y,
                                    tspan.DX,
                                    tspan.DY,
                                    tspan.FontInfo.GetFont(this, _fontData),
                                    tspan.Text);
                            }
                        }
332
333
334
					}

                	_path.CloseFigure();
davescriven's avatar
davescriven committed
335
336
337
338
                    this.IsPathDirty = false;
                }
                return _path;
            }
339
340
341
342
            protected set
            {
                _path = value;
            }
davescriven's avatar
davescriven committed
343
        }
344

samjudson's avatar
samjudson committed
345
346
347
        private static string ValidateFontFamily(string fontFamilyList)
        {
            // Split font family list on "," and then trim start and end spaces and quotes.
348
            var fontParts = fontFamilyList.Split(new[] { ',' }).Select(fontName => fontName.Trim(new[] { '"', ' ','\''  }));
samjudson's avatar
samjudson committed
349
350
351
352

            var families = System.Drawing.FontFamily.Families;

            // Find a the first font that exists in the list of installed font families.
353
354
            //styles from IE get sent through as lowercase.
            foreach (var f in fontParts.Where(f => families.Any(family => family.Name.ToLower() == f.ToLower())))
samjudson's avatar
samjudson committed
355
356
357
358
359
360
            {
                return f;
            }
            // No valid font family found from the list requested.
            return DefaultFontFamily;
        }
361

362
		private void DrawString(GraphicsPath path, SvgUnit x, SvgUnit y, SvgUnit dx, SvgUnit dy, Font font, string text)
363
		{
364
            PointF location = PointF.Empty;
365
366
367
368
369
370
			SizeF stringBounds;

			lock (_stringMeasure)
			{
				stringBounds = _stringMeasure.MeasureString(text, font);
			}
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405

			float xToDevice = x.ToDeviceValue(this) + dx.ToDeviceValue(this);
			float yToDevice = y.ToDeviceValue(this, true) + dy.ToDeviceValue(this, true);

			// Minus FontSize because the x/y coords mark the bottom left, not bottom top.
			switch (this.TextAnchor)
			{
				case SvgTextAnchor.Start:
					location = new PointF(xToDevice, yToDevice - stringBounds.Height);
					break;
				case SvgTextAnchor.Middle:
					location = new PointF(xToDevice - (stringBounds.Width / 2), yToDevice - stringBounds.Height);
					break;
				case SvgTextAnchor.End:
					location = new PointF(xToDevice - stringBounds.Width, yToDevice - stringBounds.Height);
					break;
			}

			// No way to do letter-spacing or word-spacing, so do manually
			if (this.LetterSpacing.Value > 0.0f || this.WordSpacing.Value > 0.0f)
			{
				// Cut up into words, or just leave as required
				string[] words = (this.WordSpacing.Value > 0.0f) ? text.Split(' ') : new string[] { text };
				float wordSpacing = this.WordSpacing.ToDeviceValue(this);
				float letterSpacing = this.LetterSpacing.ToDeviceValue(this);
				float start = this.X.ToDeviceValue(this);

				foreach (string word in words)
				{
					// Only do if there is line spacing, just write the word otherwise
					if (this.LetterSpacing.Value > 0.0f)
					{
						char[] characters = word.ToCharArray();
						foreach (char currentCharacter in characters)
						{
406
                            path.AddString(currentCharacter.ToString(), font.FontFamily, (int)font.Style, font.Size, location, StringFormat.GenericTypographic);
407
408
409
410
411
							location = new PointF(path.GetBounds().Width + start + letterSpacing, location.Y);
						}
					}
					else
					{
412
                        path.AddString(word, font.FontFamily, (int)font.Style, font.Size, location, StringFormat.GenericTypographic);
413
414
415
416
417
418
419
420
421
422
					}

					// Move the location of the word to be written along
					location = new PointF(path.GetBounds().Width + start + wordSpacing, location.Y);
				}
			}
			else
			{
				if (!string.IsNullOrEmpty(text))
				{
423
                    path.AddString(text, font.FontFamily, (int)font.Style, font.Size, location, StringFormat.GenericTypographic);
424
425
426
427
				}
			}

		}
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
		
		[SvgAttribute("onchange")]
        public event EventHandler<StringArg> Change;
		
		//change
        protected void OnChange(string newString, string sessionID)
        {
        	RaiseChange(this, new StringArg {s = newString, SessionID = sessionID});
        }
        
        protected void RaiseChange(object sender, StringArg s)
        {
        	var handler = Change;
            if (handler != null)
            {
                handler(sender, s);
            }
        }
446

Eric Domke's avatar
Eric Domke committed
447
#if Net4
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
		public override void RegisterEvents(ISvgEventCaller caller)
		{
			//register basic events
			base.RegisterEvents(caller); 
			
			//add change event for text
            caller.RegisterAction<string, string>(this.ID + "/onchange", OnChange);
		}
		
		public override void UnregisterEvents(ISvgEventCaller caller)
		{
			//unregister base events
			base.UnregisterEvents(caller);
			
			//unregister change event
        	caller.UnregisterAction(this.ID + "/onchange");
			
		}
Eric Domke's avatar
Eric Domke committed
466
#endif
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486

		public override SvgElement DeepCopy()
		{
			return DeepCopy<SvgText>();
		}

		public override SvgElement DeepCopy<T>()
		{
			var newObj = base.DeepCopy<T>() as SvgText;
			newObj.TextAnchor = this.TextAnchor;
			newObj.WordSpacing = this.WordSpacing;
			newObj.LetterSpacing = this.LetterSpacing;
			newObj.Font = this.Font;
			newObj.FontFamily = this.FontFamily;
			newObj.FontSize = this.FontSize;
			newObj.FontWeight = this.FontWeight;
			newObj.X = this.X;
			newObj.Y = this.Y;
			return newObj;
		}
davescriven's avatar
davescriven committed
487
    }
samjudson's avatar
samjudson committed
488
}