Position Script - Revision history

Rob: /* Technical Details */

2009-02-20T08:47:02Z

Technical Details

← Older revision		Revision as of 08:47, 20 February 2009
Line 15:		Line 15:
	\|Where Used:		\|Where Used:
	\|[[Template Element (Data)\|Templates]], [[Layout Element (Data)\|Layouts]], [[Panel Element (Data)\|Panels]], [[Form Element (Data)\|Forms]], [[Sheet Element (Data)\|Sheets]]		\|[[Template Element (Data)\|Templates]], [[Layout Element (Data)\|Layouts]], [[Panel Element (Data)\|Panels]], [[Form Element (Data)\|Forms]], [[Sheet Element (Data)\|Sheets]]
			\|-
			\|Procedure Use:
			\|None
	\|-		\|-
	\|}		\|}

Rob at 00:11, 16 December 2008

2008-12-16T00:11:37Z

← Older revision		Revision as of 00:11, 16 December 2008
Line 12:		Line 12:
	\|Fields Finalized?		\|Fields Finalized?
	\|Yes		\|Yes
			\|-
			\|Where Used:
			\|[[Template Element (Data)\|Templates]], [[Layout Element (Data)\|Layouts]], [[Panel Element (Data)\|Panels]], [[Form Element (Data)\|Forms]], [[Sheet Element (Data)\|Sheets]]
	\|-		\|-
	\|}		\|}

Rob at 09:14, 12 December 2008

2008-12-12T09:14:37Z

← Older revision		Revision as of 09:14, 12 December 2008
Line 30:		Line 30:

	Within a visual container, the position of elements is always relative to the upper left corner of the container. If the container has a margin assigned, then upper left corner is adjusted accordingly. This ensures that the visual container can be positioned anywhere within its container, and the visual elements within don't need any knowledge of the container's position.		Within a visual container, the position of elements is always relative to the upper left corner of the container. If the container has a margin assigned, then upper left corner is adjusted accordingly. This ensures that the visual container can be positioned anywhere within its container, and the visual elements within don't need any knowledge of the container's position.

			{{important}}The Position script for a template within a table is invoked separately for each item shown within the table. If the template is within a table containing items of non-varying height (the norm), the Position script is also invoked one '''additional''' time. The occurs '''before''' each item is processed and serves the purposes of calculating the of each item. When invoked for sizing, all text-based fields are empty and all value-based fields have a value of zero. The "issizing" target reference allows detection of this special use.

	{{note}}The Position script is read-only with respect to the contents of the portfolio, although visual elements may be modified. Within this script, all aspects of the hierarchy can be accessed, but nothing can be changed.		{{note}}The Position script is read-only with respect to the contents of the portfolio, although visual elements may be modified. Within this script, all aspects of the hierarchy can be accessed, but nothing can be changed.

Rob at 20:52, 8 December 2008

2008-12-08T20:52:20Z

@@ Line 1: / Line 1: @@
 {{context|Kit Reference|Script Types}}
 ==Technical Details==
@@ Line 32: / Line 22: @@
 |-
 |}
 ==Example==

Rob at 00:41, 8 December 2008

2008-12-08T00:41:10Z

← Older revision		Revision as of 00:41, 8 December 2008
Line 3:		Line 3:
	==Description==		==Description==

	The location of visual elements on the display ~~is controlled via a number of different scripts. The location of templates~~ is controlled via the Position script. ~~Since templates are displayed~~ within layouts ~~that contain multiple~~ visual elements, the ~~actual position~~ and ~~dimensions~~ of a template are ~~usually controlled~~ by ~~its container~~. However, within ~~the~~ Position script~~, the location and dimensions~~ of the ~~portals~~ within the ~~template are also controlled. These portals are~~ always ~~positioned~~ relative to the upper left corner of the ~~template itself~~, ~~so keep this in mind when performing~~ any ~~calculations~~.		The location of visual elements on the display is controlled via the Position script. This script is used the same way within scenes, layouts, and templates. Through this script, the visual elements contained within are sized and positioned. For example, a Position script for a template will coordinate the sizing and positioning of the various portals that are defined within the template.

			Most visual elements are sized and positioned by their containing element. For example, a layout is often told by the containing scene how much space it gets to utilize and then it sizes it contents to fit within that space. However, there are times when visual elements must size themselves, so it is also possible for a visual element to size itself within its Position script. An example of this is where you have a template within a table that needs to determine its own height based on the information being shown within.

			Within a visual container, the position of elements is always relative to the upper left corner of the container. If the container has a margin assigned, then upper left corner is adjusted accordingly. This ensures that the visual container can be positioned anywhere within its container, and the visual elements within don't need any knowledge of the container's position.

	{{note}}The Position script is read-only with respect to the contents of the portfolio, although visual elements may be modified. Within this script, all aspects of the hierarchy can be accessed, but nothing can be changed.		{{note}}The Position script is read-only with respect to the contents of the portfolio, although visual elements may be modified. Within this script, all aspects of the hierarchy can be accessed, but nothing can be changed.
Line 31:		Line 35:
	==Example==		==Example==

	~~For an example, we'll assume that~~ we have a template that contains two portals: a label portal and a edit portal. The ~~label portal is simply a literal string that~~ is used to ~~indicate~~ the ~~contents~~ of the ~~edit~~ portal~~. The~~ edit portal allows the user to ~~modify the contents of a field within the pick, just like~~ the ~~hero's~~ name ~~is presented atop the display when using the d20 System data files~~. ~~We assume that~~ the ~~location~~ of ~~the template itself is controlled by~~ its ~~container~~, ~~with~~ the ~~template controlling its width~~ and ~~its contents~~. The Position script for a simple template like this might look like ~~below:~~		Assume we have a template that contains two portals: a label portal and an edit portal. The template is used to let the user edit the name of something, so the label portal displays "Name:" and the edit portal allows the user to edit the name. The label portal will be automatically sized to the width of its text, so all we need to do is size the edit portal and position both portals. The Position script for a simple template like this might look like the following.

	<pre>		<pre>
	portal[~~stLblName~~].~~width =~~ portal[~~stLblName~~].~~textwidth~~		~center both portals vertically
	portal[~~stEdtName~~].left = portal~~[stLblName].~~right ~~+ 15~~		perform portal[label].centervert
	portal[~~stEdtName~~].~~height~~ = portal[~~stEdtName~~].~~fontheight + 2~~		perform portal[edit].centervert
	~~width = portal~~[~~stEdtName~~]~~.right~~
			~pick a width for the edit portal
			portal[edit].width = 150

			~put the label on the left and the edit portal on its right
			portal[label].left = 0
			perform portal[edit].alignrel[ltor,label,10]
	</pre>		</pre>

Rob at 00:13, 8 December 2008

2008-12-08T00:13:56Z

← Older revision		Revision as of 00:13, 8 December 2008
Line 21:		Line 21:
	\|}		\|}

	~~==Special Symbols==~~		The Position script utilizes the following special symbols:

	:{\| class="infotable"		:{\| class="infotable"

Rob at 00:12, 8 December 2008

2008-12-08T00:12:58Z

← Older revision		Revision as of 00:12, 8 December 2008
Line 1:		Line 1:
	{{context\|Kit Reference\|Script Types}}		{{context\|Kit Reference\|Script Types}}

			==Description==

			The location of visual elements on the display is controlled via a number of different scripts. The location of templates is controlled via the Position script. Since templates are displayed within layouts that contain multiple visual elements, the actual position and dimensions of a template are usually controlled by its container. However, within the Position script, the location and dimensions of the portals within the template are also controlled. These portals are always positioned relative to the upper left corner of the template itself, so keep this in mind when performing any calculations.

			{{note}}The Position script is read-only with respect to the contents of the portfolio, although visual elements may be modified. Within this script, all aspects of the hierarchy can be accessed, but nothing can be changed.

			==Technical Details==

	:{\| class="scripttable"		:{\| class="scripttable"
	\|class="leftnormal"\|Initial Context:		\|class="leftnormal"\|Initial Context:
	\|~~Scene (~~[[Scene Context ~~Transitions~~\|~~context transitions]], [[~~Scene ~~Target References\|target references~~]]) or~~<br>~~		\|[[Scene Context\|Scene]] or [[Layout Context\|Layout]] or [[Template Context\|Template]]
	~~Layout (~~[[Layout Context ~~Transitions~~\|~~context transitions]], [[~~Layout ~~Target References\|target references~~]]) or~~<br>~~
	~~Template (~~[[Template Context ~~Transitions~~\|~~context transitions]], [[~~Template ~~Target References\|target references~~]]~~)<br>~~
	\|-		\|-
	\|Alternate Context:		\|Alternate Context:
	\|None		\|None
	\|-		\|-
	\|Fields Finalized:		\|Fields Finalized?
	\|Yes		\|Yes
	\|-		\|-
	\|}		\|}

	~~Initial Context~~: ~~scene~~, ~~layout~~, or template		==Special Symbols==

			:{\| class="infotable"
			\|class="leftnormal"\|-None-
			\|There are no special symbols for a Position script
			\|-
			\|}

			==Example==

			For an example, we'll assume that we have a template that contains two portals: a label portal and a edit portal. The label portal is simply a literal string that is used to indicate the contents of the edit portal. The edit portal allows the user to modify the contents of a field within the pick, just like the hero's name is presented atop the display when using the d20 System data files. We assume that the location of the template itself is controlled by its container, with the template controlling its width and its contents. The Position script for a simple template like this might look like below:

	~~description~~		<pre>
	~~initial context~~		portal[stLblName].width = portal[stLblName].textwidth
	~~alternate context (if any)~~		portal[stEdtName].left = portal[stLblName].right + 15
	~~are field values finalized?~~		portal[stEdtName].height = portal[stEdtName].fontheight + 2
	~~special symbols~~		width = portal[stEdtName].right
	~~example~~		</pre>

Rob at 13:35, 7 December 2008

2008-12-07T13:35:31Z

@@ Line 1: / Line 1: @@
 {{context|Kit Reference|Script Types}}
-Initial Context: [[]]
+:{| class="scripttable"
 description
 initial context

Rob: New page: {{context|Kit Reference|Script Types}} Initial Context: [[]] description initial context alternate context (if any) are field values finalized? special symbols example

2008-12-07T12:49:26Z

New page: {{context|Kit Reference|Script Types}} Initial Context: [[]] description initial context alternate context (if any) are field values finalized? special symbols example

New page

{{context|Kit Reference|Script Types}}

Initial Context: [[]]
description
initial context
alternate context (if any)
are field values finalized?
special symbols
example