VideotexMapPage Object

VideotexMapPage Creation

The create function can be used to create a VideotexMapper object eg.

    (create VideotexMapPage)

VideotexMapPage Properties

A VideotexMapPage object supports the following properties:

property name	property type	description
name	String	the name of this page -- must be unique amongst all page definitions for this service
neighbours	List	list of pages which are adjacent to this on the Videotex service

VideotexMapPage Methods

A VideotexMapPage object supports the following methods:

method name	description
matches	test if this page matches the supplied screen
isComplete	determine if there is enough data on the screen to map the page
options	return the list of page options
translateOption	translate an option into data to upload -- returns an a-list of (field,value) pairs
scrape	scrape the data from the screen
map	map the page
makeHtml	make HTML representation of the screen

matches

Test if this page matches the supplied screen.

Arguments:

screen	Screen
env	HashTable

Return type: the empty List () is returned if the page does not match

isComplete

Determine if there is enough data on the screen to map the page.

Arguments:

screen

Screen

Return type: the empty List () is returned if the page does not match

options

Return the list of page options.

Arguments:

screen	Screen
env	HashTable

Return type: List of Strings.

translateOption

Translate an option into data to upload -- returns an a-list of (field,value) pairs.

Arguments:

option	String
screen	Screen
env	HashTable

Return type: List

scrape

Scrape the data from the screen.

Arguments:

screen	Screen
env	HashTable
data	HashTable

Return type: the empty List ()

map

Map the page.

Arguments:

screen	Screen
env	HashTable

Return type: Object

makeHtml

Make an HTML representation of the screen.

Arguments:

screen	Screen
env	HashTable
pageData	HashTable

Return type: String

Contents

Current topic: videotex

Related topics: VideotexMapper object