Package | com.vmware.tiwo.events |
Class | public class TiwoRegistrationRequestEvent |
Inheritance | TiwoRegistrationRequestEvent ![]() ![]() |
... var wizard:ChassisWizard = new ChassisWizard(); var title:String = Util.getString("wizard.title"); var icon:Class = Util.getImage("chassis"); var tiwoEvent:TiwoRegistrationRequestEvent = new TiwoRegistrationRequestEvent(icon, title, wizard); dispatchEvent(tiwoEvent);
TiwoFeatures.PERSISTENCE
to the TiwoRegistrationRequestEvent
features and add the [Persistable] tag to relevant properties. See TiwoFeatures for
more details on this and other features.
See also
Property | Defined By | ||
---|---|---|---|
![]() | context : Object
Optional context that might be required to handle the response. | Request | |
description : String
Short description or title for the Tiwo item, displayed next to the icon. | TiwoRegistrationRequestEvent | ||
features : TiwoFeatures
The features added to this item. | TiwoRegistrationRequestEvent | ||
icon : Object
(Optional) Icon to be added to the item in "Work in Progress". | TiwoRegistrationRequestEvent | ||
id : String
(Optional) String that uniquely identifies this item with Tiwo Manager. | TiwoRegistrationRequestEvent | ||
object : Object
The object to register. | TiwoRegistrationRequestEvent |
Method | Defined By | ||
---|---|---|---|
TiwoRegistrationRequestEvent(icon:Object, description:String, object:Object, id:String = null)
Creates a new event to register a Tiwo item such as a wizard. | TiwoRegistrationRequestEvent | ||
![]() | clone():Event [override]
Creates a clone of this event. | Request |
Constant | Defined By | ||
---|---|---|---|
REQUEST_ID : String = tiwoRegistrationRequest [static] | TiwoRegistrationRequestEvent | ||
RESPONSE_ID : String = tiwoRegistrationResponse [static] | TiwoRegistrationRequestEvent |
description | property |
public var description:String
Short description or title for the Tiwo item, displayed next to the icon. When registering a wizard this is also used as the container's title.
features | property |
public var features:TiwoFeatures
The features added to this item.
By default the constructor adds TiwoFeatures.HELP
. You need to add
TiwoFeatures.PERSISTENCE
explicitely to provide persistence.
See also
icon | property |
public var icon:Object
(Optional) Icon to be added to the item in "Work in Progress". null can be used if no icon is desired. When registering a wizard the icon also appears in the frame.
id | property |
public var id:String
(Optional) String that uniquely identifies this item with Tiwo Manager.
If id is null, a unique id is automatically generated and returned for your reference inTiwoRegistrationResponseEvent.result
.
If the id is already in use by other item the registration will be ignored.
Once the existing item has been deleted the same id can be used again. This can be
useful if you want to limit users to only one wizard for a particular purpose:
pass a fixed id in the wizard's TiwoRegistrationRequestEvent and the new wizard
won't appear if a similar one already exists.
The default value is null
.
object | property |
public var object:Object
The object to register. The current SDK only supports the registration of
AppWizard
objects, although Tiwo is used internally for other things.
TiwoRegistrationRequestEvent | () | Constructor |
public function TiwoRegistrationRequestEvent(icon:Object, description:String, object:Object, id:String = null)
Creates a new event to register a Tiwo item such as a wizard. See this class properties for a description of the parameters.
Parametersicon:Object | |
description:String | |
object:Object | |
id:String (default = null )
|
REQUEST_ID | Constant |
public static const REQUEST_ID:String = tiwoRegistrationRequest
RESPONSE_ID | Constant |
public static const RESPONSE_ID:String = tiwoRegistrationResponse