Class TColoringLimits

DescriptionHierarchyFieldsMethodsProperties

Unit

DataSetUnit

Declaration

type TColoringLimits = class(TPersistent)

Description

When the grid is colored by a TDataArray, the colors can be restricted to lie within a range. TColoringLimits is used to represent both ends of the range. See TColoringLimit.

Hierarchy

Overview

Fields

Private FLowerLimit: TColoringLimit;
Private FUpperLimit: TColoringLimit;
Private FActiveOnly: boolean;
Private FIntegerValuesToSkip: TSkipIntegerCollection;
Private FRealValuesToSkip: TSkipRealCollection;
Private FStringValuesToSkip: TStrings;
Private FLogTransform: boolean;
Private FStoredEpsilon: TRealStorage;
Private FShadeInactiveArea: boolean;
Private FOnChange: TNotifyEvent;

Methods

Private procedure SetLowerLimit(const Value: TColoringLimit);
Private procedure SetUpperLimit(const Value: TColoringLimit);
Private procedure SetActiveOnly(const Value: boolean);
Private procedure SetIntegerValuesToSkip(const Value: TSkipIntegerCollection);
Private procedure SetRealValuesToSkip(const Value: TSkipRealCollection);
Private procedure SetStringValuesToSkip(const Value: TStrings);
Private function StoreRealSkipValues: boolean;
Private function StoreIntegerSkipValues: boolean;
Private procedure SetLogTransform(const Value: boolean);
Private function GetEpsilon: double;
Private procedure SetEpsilon(const Value: double);
Private procedure SetStoredEpsilon(const Value: TRealStorage);
Private procedure Changed;
Private procedure SetOnChange(const Value: TNotifyEvent);
Public procedure Assign(Source: TPersistent); override;
Public constructor Create;
Public destructor Destroy; override;
Public procedure Update;
Public function ValueOk(AValue: double): boolean; overload;
Public function ValueOk(AValue: integer): boolean; overload;
Public function ValueOk(const AValue: String): boolean; overload;

Properties

Public property Epsilon: double read GetEpsilon write SetEpsilon;
Public property ShadeInactiveArea: boolean read FShadeInactiveArea write FShadeInactiveArea;
Public property OnChange: TNotifyEvent read FOnChange write SetOnChange;
Published property ActiveOnly: boolean read FActiveOnly write SetActiveOnly stored FActiveOnly;
Published property LowerLimit: TColoringLimit read FLowerLimit write SetLowerLimit;
Published property UpperLimit: TColoringLimit read FUpperLimit write SetUpperLimit;
Published property RealValuesToSkip: TSkipRealCollection read FRealValuesToSkip write SetRealValuesToSkip stored StoreRealSkipValues;
Published property IntegerValuesToSkip: TSkipIntegerCollection read FIntegerValuesToSkip write SetIntegerValuesToSkip stored StoreIntegerSkipValues;
Published property StringValuesToSkip: TStrings read FStringValuesToSkip write SetStringValuesToSkip;
Published property LogTransform: boolean read FLogTransform write SetLogTransform;
Published property StoredEpsilon: TRealStorage read FStoredEpsilon write SetStoredEpsilon;

Description

Fields

Private FLowerLimit: TColoringLimit;

See LowerLimit.

Private FUpperLimit: TColoringLimit;

See UpperLimit.

Private FActiveOnly: boolean;
 
Private FIntegerValuesToSkip: TSkipIntegerCollection;
 
Private FRealValuesToSkip: TSkipRealCollection;
 
Private FStringValuesToSkip: TStrings;
 
Private FLogTransform: boolean;
 
Private FStoredEpsilon: TRealStorage;
 
Private FShadeInactiveArea: boolean;
 
Private FOnChange: TNotifyEvent;
 

Methods

Private procedure SetLowerLimit(const Value: TColoringLimit);

See LowerLimit.

Private procedure SetUpperLimit(const Value: TColoringLimit);

See UpperLimit.

Private procedure SetActiveOnly(const Value: boolean);
 
Private procedure SetIntegerValuesToSkip(const Value: TSkipIntegerCollection);
 
Private procedure SetRealValuesToSkip(const Value: TSkipRealCollection);
 
Private procedure SetStringValuesToSkip(const Value: TStrings);
 
Private function StoreRealSkipValues: boolean;
 
Private function StoreIntegerSkipValues: boolean;
 
Private procedure SetLogTransform(const Value: boolean);
 
Private function GetEpsilon: double;
 
Private procedure SetEpsilon(const Value: double);
 
Private procedure SetStoredEpsilon(const Value: TRealStorage);
 
Private procedure Changed;
 
Private procedure SetOnChange(const Value: TNotifyEvent);
 
Public procedure Assign(Source: TPersistent); override;

Assign calls TColoringLimit.Assign for LowerLimit and UpperLimit and then calls Update.

Public constructor Create;

Create creates an instance of TColoringLimits.

Public destructor Destroy; override;

Destroy destroys the the current instance of TColoringLimits. Do not call Destroy directly. Call Free instead.

Public procedure Update;

If both the LowerLimit and UpperLimit are used (see TColoringLimit.UseLimit), Update insures that the upper limit is greater than or equal to the lower limit.

Public function ValueOk(AValue: double): boolean; overload;
 
Public function ValueOk(AValue: integer): boolean; overload;
 
Public function ValueOk(const AValue: String): boolean; overload;
 

Properties

Public property Epsilon: double read GetEpsilon write SetEpsilon;
 
Public property ShadeInactiveArea: boolean read FShadeInactiveArea write FShadeInactiveArea;
 
Public property OnChange: TNotifyEvent read FOnChange write SetOnChange;
 
Published property ActiveOnly: boolean read FActiveOnly write SetActiveOnly stored FActiveOnly;
 
Published property LowerLimit: TColoringLimit read FLowerLimit write SetLowerLimit;

LowerLimit is the lower limit on what values should be used to color the grid.

Published property UpperLimit: TColoringLimit read FUpperLimit write SetUpperLimit;

UpperLimit is the upper limit on what values should be used to color the grid.

Published property RealValuesToSkip: TSkipRealCollection read FRealValuesToSkip write SetRealValuesToSkip stored StoreRealSkipValues;
 
Published property IntegerValuesToSkip: TSkipIntegerCollection read FIntegerValuesToSkip write SetIntegerValuesToSkip stored StoreIntegerSkipValues;
 
Published property StringValuesToSkip: TStrings read FStringValuesToSkip write SetStringValuesToSkip;
 
Published property LogTransform: boolean read FLogTransform write SetLogTransform;
 
Published property StoredEpsilon: TRealStorage read FStoredEpsilon write SetStoredEpsilon;
 
Generated by PasDoc 0.12.1 on 2013-05-13 15:41:30