Skinner Documentation
Table Of Contents
Table Of ContentsAuthor: Grant
Last Modified: 2004/5/15
Generator: gModeler.com.
Description
Enter a description.
No documentation available.
com.gskinner Nested Elements
netNo documentation available.
net Nested Elements
EventProxyNo documentation available.
events Nested Elements
XML2No documentation available.
EventProxy Properties
None.
EventProxy Methods
None.
EventProxy Events
None.
EventProxy Associations
None.
No documentation available.
XML2 Properties
None.
XML2 Methods
None.
XML2 Events
None.
XML2 Associations
DirectoryDelegate has XML2
No documentation available.
directory Nested Elements
MainNo documentation available.
Main Properties
None.
Main Methods
None.
Main Events
None.
Main Associations
Main has
Main has
Main has
Main has
Main has
Main has
No documentation available.
net Nested Elements
DirectoryDelegateAvailability
Flash Player 7.
Usage
new DirectoryDelegate()
Parameters
None.
Returns
Nothing.
Description
Responsible for all communication with the backend.
Example
DirectoryDelegate Properties
None.
DirectoryDelegate Methods
addEventListener : Void
Availability
Flash Player 7.
Usage
DirectoryDelegate
.addEventListener(eventName,listener
)
Parameters
eventName
eventName parameter. (String)
listener
listener parameter. (Object)
Returns
Nothing.
Description
Adds a listener for a specified event.
Example
addUser : Boolean
Availability
Flash Player 7.
Usage
DirectoryDelegate
.addUser(user,token
)
Parameters
user
user parameter. (User)
token
An arbitrary object used to identify this load. (Object)
Returns
A Boolean.
Description
Attempts to add a user to the database. Triggers a load event on success or failure.
Example
deleteUser : Boolean
Availability
Flash Player 7.
Usage
DirectoryDelegate
.deleteUser(user,token
)
Parameters
user
user parameter. (User)
token
An arbitrary object used to identify this load. (Object)
Returns
A Boolean.
Description
Attempts to remove a user from the database. Triggers a load event on success or failure.
Example
getPreliminaryData : Boolean
Availability
Flash Player 7.
Usage
DirectoryDelegate
.getPreliminaryData(token
)
Parameters
token
An arbitrary object used to identify this load. (Object)
Returns
A Boolean.
Description
Attempts to load the initial user data from the database. Triggers a load event on success or failure.
Example
removeEventListener : Void
Availability
Flash Player 7.
Usage
DirectoryDelegate
.removeEventListener(eventName,listener
)
Parameters
eventName
eventName parameter. (String)
listener
listener parameter. (Object)
Returns
Nothing.
Description
Removes a listener for a specific event.
Example
updateUser : Boolean
Availability
Flash Player 7.
Usage
DirectoryDelegate
.updateUser(user,token
)
Parameters
user
user parameter. (User)
token
An arbitrary object used to identify this load. (Object)
Returns
A Boolean.
Description
Attempts to update a user in the database. Triggers a load event on success or failure.
Example
DirectoryDelegate Events
load : Void
Availability
Flash Player 7.
Usage
DirectoryDelegate
.load()
Parameters
None.
Returns
Nothing.
Description
Dispatched whenever a load succeeds or fails. Event object includes a success property, the associated token, and data specific to the type of load.
Example
DirectoryDelegate Associations
DirectoryDelegate is dependent upon
DirectoryDelegate is dependent upon
Main has DirectoryDelegate
DirectoryDelegate has
No documentation available.
data Nested Elements
UserListAvailability
Flash Player 7.
Usage
new UserList(xml
)
Parameters
xml
xml to build the list from. (XML)
Returns
Nothing.
Description
Stores the list of users locally.
Example
UserList Properties
None.
UserList Methods
addEventListener : Void
Availability
Flash Player 7.
Usage
UserList
.addEventListener(eventName,listener
)
Parameters
eventName
eventName parameter. (String)
listener
listener parameter. (Object)
Returns
Nothing.
Description
Adds a listener for a specified event.
Example
addUser : User
Availability
Flash Player 7.
Usage
UserList
.addUser(user
)
Parameters
user
The user to add. (User)
Returns
A User.
Description
Adds the specified user to the list.
Example
fromXML : Void
Availability
Flash Player 7.
Usage
UserList
.fromXML(xml
)
Parameters
xml
xml parameter. (XML)
Returns
Nothing.
Description
Assembles UserList from the specified xml.
Example
getDataProvider : Array
Availability
Flash Player 7.
Usage
UserList
.getDataProvider()
Parameters
None.
Returns
A Array.
Description
Returns an array of User instances that can be used as a dataprovider.
Example
removeEventListener : Void
Availability
Flash Player 7.
Usage
UserList
.removeEventListener(eventName,listener
)
Parameters
eventName
eventName parameter. (String)
listener
listener parameter. (Object)
Returns
Nothing.
Description
Removes a listener for a specified event.
Example
removeUser : User
Availability
Flash Player 7.
Usage
UserList
.removeUser(user
)
Parameters
user
The user to remove (User)
Returns
A User.
Description
Removes the specified user from the list.
Example
updateUser : User
Availability
Flash Player 7.
Usage
UserList
.updateUser(user
)
Parameters
user
The user to update. (User)
Returns
A User.
Description
Replaces an existing user with the same ID in the list.
Example
UserList Events
change : Void
Availability
Flash Player 7.
Usage
UserList
.change()
Parameters
None.
Returns
Nothing.
Description
Dispatched whenever the list changes.
Example
UserList Associations
UserListing is comprised of UserList
DirectoryDelegate is dependent upon UserList
Main has UserList
UserList has
Availability
Flash Player 7.
Usage
new User(xml
)
Parameters
xml
xml to populate this user from. (XML)
Returns
Nothing.
Description
User messenger. Represents a user in the system.
Example
User Properties
description : String
Availability
Flash Player 7.
Usage
User
.description
Description
Enter a description.
Example
division_id : String
Availability
Flash Player 7.
Usage
User
.division_id
Description
Enter a description.
Example
email : String
Availability
Flash Player 7.
Usage
User
.email
Description
Enter a description.
Example
executive : Boolean
Availability
Flash Player 7.
Usage
User
.executive
Description
Enter a description.
Example
fax : String
Availability
Flash Player 7.
Usage
User
.fax
Description
Enter a description.
Example
first_name : String
Availability
Flash Player 7.
Usage
User
.first_name
Description
Enter a description.
Example
full_name : String
Availability
Flash Player 7.
Usage
User
.full_name
Description
Read-only. Automatically assembled from first_name and last_name
Example
id : String
Availability
Flash Player 7.
Usage
User
.id
Description
Enter a description.
Example
label : String
Availability
Flash Player 7.
Usage
User
.label
Description
Read-only. Returns full_name value. Used in dataproviders.
Example
last_name : String
Availability
Flash Player 7.
Usage
User
.last_name
Description
Enter a description.
Example
phone : String
Availability
Flash Player 7.
Usage
User
.phone
Description
Enter a description.
Example
User Methods
fromXML : Void
Availability
Flash Player 7.
Usage
User
.fromXML(xml
)
Parameters
xml
xml parameter. (XML)
Returns
Nothing.
Description
Populates the User from the specified xml.
Example
User Events
None.
User Associations
UserDetails is comprised of User
DirectoryDelegate is dependent upon User
UserList has User
Availability
Flash Player 7.
Usage
new DivisionList(xml
)
Parameters
xml
The xml to populate the list from. (XML)
Returns
Nothing.
Description
Holds the list of available divisions using generic objects (mainly for demonstration)
Example
DivisionList Properties
None.
DivisionList Methods
fromXML : Void
Availability
Flash Player 7.
Usage
DivisionList
.fromXML(xml
)
Parameters
xml
the xml to populate the list from. (XML)
Returns
Nothing.
Description
Populates the DivisionList instance from the specified xml.
Example
getDataProvider : Array
Availability
Flash Player 7.
Usage
DivisionList
.getDataProvider()
Parameters
None.
Returns
A Array.
Description
Returns an array of objects that can be used as a dataprovider.
Example
indexOf : Number
Availability
Flash Player 7.
Usage
DivisionList
.indexOf(id
)
Parameters
id
id parameter. (String)
Returns
A Number.
Description
Returns the index of a specified division id in the list or -1 if it does not exist.
Example
DivisionList Events
None.
DivisionList Associations
UserDetails is comprised of DivisionList
Main has DivisionList
No documentation available.
views Nested Elements
DialogAvailability
Flash Player 7.
Usage
new Dialog()
Parameters
None.
Returns
Nothing.
Description
Displays a dialog to the user. Bound to a MovieClip.
Example
Dialog Properties
None.
Dialog Methods
hide : Void
Availability
Flash Player 7.
Usage
Dialog
.hide()
Parameters
None.
Returns
Nothing.
Description
Hides the dialog.
Example
show : Void
Availability
Flash Player 7.
Usage
Dialog
.show(title,message,closeBtn,delay
)
Parameters
title
title parameter. (String)
message
message parameter. (String)
closeBtn
Indicates whether to show a close button on the dialog (Boolean)
delay
Specifies the delay before showing the dialog. The screen will be locked immediately, but the actual dialog will be delayed. (Number)
Returns
Nothing.
Description
Shows a dialog.
Example
Dialog Events
None.
Dialog Associations
UserDetails is comprised of Dialog
Main has Dialog
Availability
Flash Player 7.
Usage
new UserListing()
Parameters
None.
Returns
Nothing.
Description
Displays a UserList, and provides an interface for the user to request modifications to the list. Bound to a movieclip.
Example
UserListing Properties
None.
UserListing Methods
addEventListener : Void
No documentation available.
registerUserList : Void
Availability
Flash Player 7.
Usage
UserListing
.registerUserList(userList
)
Parameters
userList
userList parameter. (UserList)
Returns
Nothing.
Description
Registers the specified UserList to this view.
Example
removeEventListener : Void
No documentation available.
UserListing Events
deleteUser : Void
Availability
Flash Player 7.
Usage
UserListing
.deleteUser()
Parameters
None.
Returns
Nothing.
Description
Dispatched when the delete button is clicked. Event object includes a property "user" which contains a reference to the currently selected user.
Example
editUser : Void
Availability
Flash Player 7.
Usage
UserListing
.editUser()
Parameters
None.
Returns
Nothing.
Description
Dispatched when the add button is clicked. Event object includes a property "user" which contains a reference to the currently selected user.
Example
newUser : Void
Usage
Parameters
None.
Description
Enter a description.
Example
UserListing Associations
UserListing is comprised of
Main has UserListing
Availability
Flash Player 7.
Usage
new UserDetails()
Parameters
None.
Returns
Nothing.
Description
Displays and facilitates editing of a single User object. The original User object is not touched, instead a new user object (with the same id as the original) is created.
Example
UserDetails Properties
None.
UserDetails Methods
registerDialog : Void
Availability
Flash Player 7.
Usage
UserDetails
.registerDialog(dialog
)
Parameters
dialog
dialog parameter. (Dialog)
Returns
Nothing.
Description
Registers a dialog to use for displaying data validation messages.
Example
registerDivisionList : Void
Availability
Flash Player 7.
Usage
UserDetails
.registerDivisionList(divisionList
)
Parameters
divisionList
divisionList parameter. (DivisionList)
Returns
Nothing.
Description
Registers a DivisionList to be displayed in the division combo box.
Example
registerUser : Void
Availability
Flash Player 7.
Usage
UserDetails
.registerUser(user
)
Parameters
user
user parameter. (User)
Returns
Nothing.
Description
Registers the User object to edit.
Example
UserDetails Events
cancelEdit : Void
Availability
Flash Player 7.
Usage
UserDetails
.cancel()
Parameters
None.
Returns
Nothing.
Description
Dispatched when the cancel button is pressed.
Example
saveUser : Void
Availability
Flash Player 7.
Usage
UserDetails
.saveUser()
Parameters
None.
Returns
Nothing.
Description
Dispatched when the save button is pressed. Event object includes a "user" property containing the new User object.
Example
UserDetails Associations
UserDetails is comprised of
UserDetails is comprised of
UserDetails is comprised of
Main has UserDetails