previous chapter contents page top page next chapter


BrowsingListViewScene

March 15, 1996

inherits from Scene;

Class Description

Magic Cap defines class BrowsingListViewScene for scenes that contain lists of objects. The user can touch any object to select it. Magic Cap uses members of this class for storage box scenes in the storeroom and for purging scenes.

Programming information

Instantiate: rarely
Subclass: rarely
Call its methods: never

You might create or subclass BrowsingListViewScene if you want to display a list of objects that the user can touch to select.

Methods defined by class BrowsingListViewScene

Class BrowsingListViewScene defines the following methods:

Method Description
ListView Get the list view associated with this scene.
CanDeleteSelection Returns whether selected item can be deleted.
CanGoToSelection Returns whether selected item can be viewed up close.
SafeGoToSelection Subclasses can override to confirm before go to.
GoToSelection Called by SafeGoToSelection to zoom up selected item.
SafeDestroyCheckedItems Confirms before deleting selected item.
DestroyCheckedItems Called by SafeDestroyCheckedItems to destroy objects immediately.

Fields defined by class BrowsingListViewScene

Class BrowsingListViewScene defines the following fields:

Field Type Description
Inherited from SingleLinkable:
next Object Next item in view list
Inherited from Linkable:
previous Object Previous item in view list
Inherited from Viewable:
superview Viewable Container for this object
subview Viewable Object contained by this object
relativeOrigin Dot Origin relative to superview
contentSize Dot Size of content rectangle
viewFlags Unsigned Various settings
labelStyle TextStyle Text style of object's label
color Color Color of object's content
shadow Shadow Shadow drawn with object
sound Sound Sound associated with object
Inherited from HasBorder:
border Border Border drawn around object
Inherited from Scene:
sceneFlags Unsigned Various scene settings
stepBackScene Scene Scene to step back to (at right of name bar)
stepBackSpot Viewable Place to zoom to on step back
image Image Image for scene's snapshots
additions SceneAdditions First in list of scene-specific commands
screen Buffer Cached bits to draw scene
Defined by BrowsingListViewScene
listView CheckboxListView List view associated with this scene

Method Descriptions

ListView

attribute ListView: CheckboxListView, readOnly
// operation ListView():CheckboxListView
Call: rarely
Override: rarely

The attribute ListView refers to the list view displayed in this scene.

CanDeleteSelection

attribute CanDeleteSelection: Boolean, readOnly
// operation CanDeleteSelection():Boolean
Call: rarely
Override: rarely

The attribute CanDeleteSelection returns true if the selected item can be deleted by the user.

CanGoToSelection

attribute CanGoToSelection: Boolean, readOnly
// operation CanGoToSelection():Boolean
Call: rarely
Override: rarely

The attribute CanGoToSelection returns true if the selected item can be viewed up close.

SafeGoToSelection

operation SafeGoToSelection()
Call: rarely
Override: sometimes

Magic Cap calls SafeGoToSelection when the user touches the view button in the browsing list view scene. You should override SafeGoToSelection if you want to put up a confirmation dialog before showing the selection.

GoToSelection

operation GoToSelection()
Call: rarely
Override: rarely

Magic Cap calls GoToSelection from SafeGoToSelection to show the selected item.

SafeDestroyCheckedItems

operation SafeDestroyCheckedItems()
Call: rarely
Override: rarely

Magic Cap calls SafeDestroyCheckedItems to ask the user to confirm before deleting the selected items.

DestroyCheckedItems

operation DestroyCheckedItems()
Call: rarely
Override: rarely

Magic Cap calls DestroyCheckedItems from SafeDestroyCheckedItems to destroy the selected items immediately.