Namespace: Consultingwerk.Framework.Base
Class 
AblPrimitiveList Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Base.AblPrimitiveList

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash
Inherited by: Consultingwerk.Framework.Collections.CharacterList, Consultingwerk.Framework.ServiceDefinitions, Consultingwerk.Framework.Collections.HandleList, Consultingwerk.Framework.Collections.IntegerList
ABSTRACT

File:AblPrimitiveList
Purpose:Abstract foundation for lists of ABL primitive
values
Author(s):Mike Fechner / Consulingwerk Ltd.
Created:Sun Feb 11 00:01:08 CET 2012

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ Clear () Removes all keys and values from the List
# InternalAdd (character) Adds the specified value to the list.
# LOGICAL InternalContainsValue (character) Determines whether the List contains the specified value.
# CHARACTER InternalGetValue (integer) Returns the Value for the specified Index
# INTEGER InternalIndexOf (character) Return the Index of the specified element
# InternalInsert (character, integer) Inserts the specified value to the List at the specified position
# InternalSetValue (integer, character) Assigns the Value for the specified Key
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
+ Remove (integer) Removes the Value on the given Index from the List
# ValidateValue (character) Validates a Value

Top Constructor Summary
Options Name Purpose
+ AblPrimitiveList () Constructor for the AblPrimitiveList class
+ AblPrimitiveList (longchar) Constructor for the AblPrimitiveList class
+ AblPrimitiveList (longchar, character) Constructor for the AblPrimitiveList class

Top Event Summary
Options Name Purpose
+ ListChanged (Object, ListChangedEventArgs) Raised when the List is changed by adding or removing items or clearing the list

Top Property Summary
Options Name Purpose
+ INTEGER Count Gets the number of key/value pairs contained in the List
+ CHARACTER ListHash Returns a hash value representing the current list contents
+ CHARACTER ValueDelimiter Returns the Delimiter used for the Values list
+ LONGCHAR Values Returns the list of Values in the List


Method Detail
Top

PUBLIC Clear ()
Purpose: Removes all keys and values from the List
Notes: Raises the ListChanged event

Top

PROTECTED InternalAdd (character)
Purpose: Adds the specified value to the list.
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcValue CHARACTER
The value for the key/value pair to add to the List
Top

PROTECTED LOGICAL InternalContainsValue (character)
Purpose: Determines whether the List contains the specified value.
Notes: Internal method, used by derived class (which converts from the

Parameters:
pcValue CHARACTER
The value to locate in the List
Returns LOGICAL
True, when the value is contained in the List, otherwise false
Top

PROTECTED CHARACTER InternalGetValue (integer)
Purpose: Returns the Value for the specified Index
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
piIndex INTEGER
The index to remove from the List
Returns CHARACTER
The Value for the specified Index
Top

PROTECTED INTEGER InternalIndexOf (character)
Purpose: Return the Index of the specified element
Notes: Returns 0 if the value is not in the list

Parameters:
pcValue CHARACTER
The value to locate
Returns INTEGER
The Index of the given Value
Top

PROTECTED InternalInsert (character, integer)
Purpose: Inserts the specified value to the List at the specified position
Notes:

Parameters:
pcValue CHARACTER
The value for the key/value pair to add to the List
piPosition INTEGER
The position to add the new value to
Top

PROTECTED InternalSetValue (integer, character)
Purpose: Assigns the Value for the specified Key
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
piIndex INTEGER
The index to remove from the List
pcValue CHARACTER
The value to assign for the Key in the List
Top

PROTECTED OnListChanged (ListChangedEventArgs)
Purpose: Raises the ListChanged event
Notes:

Parameters:
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event
Top

PUBLIC Remove (integer)
Purpose: Removes the Value on the given Index from the List
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
piEntry INTEGER
The index to remove from the List
Top

PROTECTED ValidateValue (character)
Purpose: Validates a Value
Notes:

Parameters:
pcValue CHARACTER
The value to validate


Constructor Detail
Top

PUBLIC AblPrimitiveList ()
Purpose: Constructor for the AblPrimitiveList class
Notes:

Top

PUBLIC AblPrimitiveList (longchar)
Purpose: Constructor for the AblPrimitiveList class
Notes: Defaults to the comma (",") as the delimiter for Keys and Values

Parameters:
pcValues LONGCHAR
The initial list of Values
Top

PUBLIC AblPrimitiveList (longchar, character)
Purpose: Constructor for the AblPrimitiveList class
Notes:

Parameters:
pcValues LONGCHAR
The initial list of Values
pcValueDelimiter CHARACTER
The delimiter for the Values


Event Detail
Top

PUBLIC ListChanged (Object, ListChangedEventArgs)
Purpose: Raised when the List is changed by adding or removing items or
clearing the list
Notes:

Parameters:
sender Progress.Lang.Object
The sender of the event
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event


Property Detail
Top

PUBLIC INTEGER Count
Purpose: Gets the number of key/value pairs contained in the List
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER ListHash
Purpose: Returns a hash value representing the current list contents
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER ValueDelimiter
Purpose: Returns the Delimiter used for the Values list
Notes:

Returns CHARACTER
Top

PUBLIC LONGCHAR Values
Purpose: Returns the list of Values in the List
Notes:

Returns LONGCHAR


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:28:36