Module:ExampleModule

From PanoZona

Contents 1 Configuration structure 2 Configuration details 2.1 ExampleModule 2.2 settings 2.3 someParent 2.4 someChild 2.5 someToy 2.6 someJob 3 Exposed functions 3.1 toggleVisibility 3.2 echoNothing 3.3 echoBoolean 3.4 echoNumber 3.5 echoString 3.6 echoAll

ExampleModule serves no other purpose then demonstraiting api solutions. Module cooperates with NavigationBar, new extra button is shown that indicates and controlls ExampleModule visibility. Example module also demonstrates methods of obtaining data from configuration. Moudule source files are well commented, it is good starting point for creating new module.

Configuration structure

• ExampleModule
  • settings
  • someParent
    • someChild
      • someToy
    • someJob

Configuration details

ExampleModule

Parent: modules

Attribute	Type	Sub-attribute	Type	Default	Values	Description
path	S	-		-	path to swf file	Mandatory attribute. Value points to module swf file.

settings

Parent: ExampleModule

Attribute	Type	Sub-attribute	Type	Default	Values	Description
open	B	-		true	true, false	Determines visibility of module on SaladoPlayer start.
onOpen	S	-		-	action id	Action executed on module closing.
onClose	S	-		-	action id	Action executed on module opening.
tween	O	transition	F	Linear.easeNone	avaible functions	Determines type of animation used when module window is opening/closing.
		time	N	0.5	-	Duration in seconds of module window opening/closing animation.
align	O	horizontal	S	left	left, right, center	Number of pixels element is moved horizontally.
		vertical	S	middle	top, middle, bottom	Vertical alignment of element against panorama window.
move	O	horizontal	N	10	-	Number of pixels element is moved horizontally.
		vertical	N	0	-	Number of pixels element is moved vertically.

someParent

Parent: ExampleModule

Attribute	Type	Sub-attribute	Type	Default	Values	Description
info	O	booleanSubValue	B	false	true, false	Sample Boolean sub-attribute.
		numberSubValue	N	NAN	-	Sample Number sub-attribute.
		stringSubValue	S	-	-	Sample String sub-attribute.

someChild

Parent: someParent

Attribute	Type	Sub-attribute	Type	Default	Values	Description
happy	B	-		-	-	Sample Boolean value.

someToy

Parent: someChild

Attribute	Type	Sub-attribute	Type	Default	Values	Description
name	S	-		-	-	Sample String value.
price	S	-		-	-	Sample Number value.

someJob

Parent: someParent

Attribute	Type	Sub-attribute	Type	Default	Values	Description
Wages	N	-		-	-	Sample Number value.
text	S	-		-	-	Sample String value. Name of this attribute indicates, that its value can either be obtained traditionally, or by adding CDATA child to someJob node.

Exposed functions

toggleVisibility

Type	Description	Function description
-	-	Calling this function toggles module visibility. If called when module is visible it hides module, same thing other way around.

echoNothing

Type	Description	Function description
-	-	Prints mesaage hard-coded into module.

echoBoolean

Type	Description	Function description
B	Sample Boolean value.	Function prints given Boolean value trace window.

echoNumber

Type	Description	Function description
N	Sample Number value.	Function prints given Number value trace window.

echoString

Type	Description	Function description
S	Sample String value.	Function prints given String value trace window.

echoAll

Type	Description	Function description
B	Sample Boolean value.	Function prints all given values in trace window.
N	Sample Number value.
S	Sample String value.