File size: 6,046 Bytes
b1b3bae |
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 |
//============================================================================
//ZedGraph Class Library - A Flexible Line Graph/Bar Graph Library in C#
//Copyright � 2006 John Champion
//
//This library is free software; you can redistribute it and/or
//modify it under the terms of the GNU General Public
//License as published by the Free Software Foundation; either
//version 2.1 of the License, or (at your option) any later version.
//
//This library is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
//General Public License for more details.
//
//You should have received a copy of the GNU General Public
//License along with this library; if not, write to the Free Software
//Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//=============================================================================
using System;
using System.Drawing;
using System.Text;
using System.Runtime.Serialization;
using System.Security.Permissions;
namespace ZedGraph
{
/// <summary>
/// Class that handles the data associated with a text title and its associated font
/// properties. Inherits from <see cref="Label" />, and adds the <see cref="Gap" />
/// property for use by the <see cref="Axis" /> and <see cref="PaneBase" /> objects.
/// </summary>
///
/// <author> John Champion </author>
/// <version> $Revision: 3.1 $ $Date: 2006-06-24 20:26:44 $ </version>
[Serializable]
public class GapLabel : Label, ICloneable, ISerializable
{
internal float _gap;
#region Constructors
/// <summary>
/// Constructor to build a <see cref="GapLabel" /> from the text and the
/// associated font properties.
/// </summary>
/// <param name="text">The <see cref="string" /> representing the text to be
/// displayed</param>
/// <param name="fontFamily">The <see cref="String" /> font family name</param>
/// <param name="fontSize">The size of the font in points and scaled according
/// to the <see cref="PaneBase.CalcScaleFactor" /> logic.</param>
/// <param name="color">The <see cref="Color" /> instance representing the color
/// of the font</param>
/// <param name="isBold">true for a bold font face</param>
/// <param name="isItalic">true for an italic font face</param>
/// <param name="isUnderline">true for an underline font face</param>
public GapLabel( string text, string fontFamily, float fontSize, Color color, bool isBold,
bool isItalic, bool isUnderline )
: base( text, fontFamily, fontSize, color, isBold, isItalic, isUnderline )
{
_gap = Default.Gap;
}
/// <summary>
/// Copy constructor
/// </summary>
/// <param name="rhs">the <see cref="AxisLabel" /> instance to be copied.</param>
public GapLabel( GapLabel rhs )
: base( rhs )
{
_gap = rhs._gap;
}
/// <summary>
/// Implement the <see cref="ICloneable" /> interface in a typesafe manner by just
/// calling the typed version of <see cref="Clone" />
/// </summary>
/// <returns>A deep copy of this object</returns>
object ICloneable.Clone()
{
return this.Clone();
}
/// <summary>
/// Typesafe, deep-copy clone method.
/// </summary>
/// <returns>A new, independent copy of this class</returns>
public new GapLabel Clone()
{
return new GapLabel( this );
}
#endregion
#region Properties
/// <summary>
/// Gets or sets the gap factor between this label and the opposing <see cref="Axis" />
/// or <see cref="Chart" />.
/// </summary>
/// <remarks>
/// This value is expressed as a fraction of the character height for the <see cref="GapLabel" />.
/// </remarks>
public float Gap
{
get { return _gap; }
set { _gap = value; }
}
/// <summary>
/// Calculate the size of the <see cref="Gap" /> based on the <see cref="Label.FontSpec" />
/// height, in pixel units and scaled according to <see paramref="scalefactor" />.
/// </summary>
/// <param name="scaleFactor">The scaling factor to be applied</param>
public float GetScaledGap( float scaleFactor )
{
return _fontSpec.GetHeight( scaleFactor ) * _gap;
}
#endregion
#region Serialization
/// <summary>
/// Current schema value that defines the version of the serialized file
/// </summary>
public const int schema2 = 10;
/// <summary>
/// Constructor for deserializing objects
/// </summary>
/// <param name="info">A <see cref="SerializationInfo"/> instance that defines the serialized data
/// </param>
/// <param name="context">A <see cref="StreamingContext"/> instance that contains the serialized data
/// </param>
protected GapLabel( SerializationInfo info, StreamingContext context )
: base( info, context )
{
// The schema value is just a file version parameter. You can use it to make future versions
// backwards compatible as new member variables are added to classes
int sch2 = info.GetInt32( "schema2" );
_gap = info.GetSingle( "gap" );
}
/// <summary>
/// Populates a <see cref="SerializationInfo"/> instance with the data needed to serialize the target object
/// </summary>
/// <param name="info">A <see cref="SerializationInfo"/> instance that defines the serialized data</param>
/// <param name="context">A <see cref="StreamingContext"/> instance that contains the serialized data</param>
[SecurityPermissionAttribute( SecurityAction.Demand, SerializationFormatter = true )]
public override void GetObjectData( SerializationInfo info, StreamingContext context )
{
base.GetObjectData( info, context );
info.AddValue( "schema2", schema2 );
info.AddValue( "gap", _gap );
}
#endregion
#region Default
/// <summary>
/// A simple struct that defines the
/// default property values for the <see cref="GapLabel"/> class.
/// </summary>
public struct Default
{
/// <summary>
/// The default <see cref="GapLabel.Gap" /> setting.
/// </summary>
public static float Gap = 0.3f;
}
#endregion
}
}
|