# ECXMLControlState

## Abstract

Stores the state of the XMLControl instance

## Methods

`-allUserObjects`
  returns all user objects which have been placed on the stack regardless of any subsequent stack operations
`-countStackObjects`
`-globalRuleData`
`-popUserObject`
  removes the top element from the stack of user object
`-pushUserObject:`
  puts a user object on top of the stack of user objects
`-userObjectAtTopPosition`

### allUserObjects

returns all user objects which have been placed on the stack regardless of any subsequent stack operations

>     - (NSArray *) allUserObjects;

method result
  array of all user objects

### countStackObjects

>     - (unsigned) countStackObjects;

method result
  returns the number of all user objects placed on the user object stack

### globalRuleData

>     - (NSMutableDictionary *) globalRuleData;

method result
  returns a dictionary which rules may use to store global values or state information etc. during the parsing process

### popUserObject

removes the top element from the stack of user object

>     - popUserObject;

method result
  the element which has been removed from the stack or nil, if stack has been empty.

##### Discussion

Note that all user objects are always available through ``, regardless of the stack operations

### pushUserObject:

puts a user object on top of the stack of user objects

>     - pushUserObject: (id) aUserObject;

method result
  self

### userObjectAtTopPosition

>     - userObjectAtTopPosition;

method result
  returns the user object at the top position of the stack of user objects or nil, if not given

(Last Updated August 27, 2006)