Template Sizing Within Tables - Revision history

Rob at 08:41, 22 November 2008

2008-11-22T08:41:12Z

← Older revision		Revision as of 08:41, 22 November 2008
Line 1:		Line 1:
	~~[[Category:~~Basic Concepts and Terminology]]		{{context\|Basic Concepts and Terminology\|Manipulation of Visual Elements\|Working With Tables}}
	~~[Context: [[Home~~\|~~HL Kit]] [[Basic Concepts and Terminology]] [[~~Manipulation of Visual Elements~~]] [[~~Working With Tables~~]]]~~

	==Overview==		==Overview==

Rob: /* Width Control */

2008-11-20T07:09:45Z

Width Control

← Older revision		Revision as of 07:09, 20 November 2008
Line 34:		Line 34:
	#If the table has multiple columns, the new template width is used to determine how many columns can actually fit within the table, '''without''' increasing the established table width. Once the number of columns is determined, the table width is changed to be exactly the space needed for those columns. Remember that a table will always be sized to contain at least one item, so setting a template width that is wider than the table width will increase the overall width of the table.		#If the table has multiple columns, the new template width is used to determine how many columns can actually fit within the table, '''without''' increasing the established table width. Once the number of columns is determined, the table width is changed to be exactly the space needed for those columns. Remember that a table will always be sized to contain at least one item, so setting a template width that is wider than the table width will increase the overall width of the table.

	~~example 1~~		The following are a couple of examples of the above rules being applied. Both examples assume that you start with a table that is 400 pixels in width and that has two columns.
	if table is 400 pixels and has two columns~~, template starts with a width of 200~~
	~~if template sets width to 300, only one column will now fit~~
	~~table width is set to 300 pixels to correspond to the one column it contains~~

	~~example 2~~		#If the template sets its width to 300, only one column will now fit. Consequently, the table width is set to 300 pixels to correspond with the one column the table contains.
	~~same starting state~~		#If the template sets its width to 125, three columns with now fit. Consequently, the table width is set to 450 pixels to correspond with the three columns the table contains.
	if template sets width to ~~150~~, three columns with now fit
	table width is set to 450 pixels to correspond to the three columns it contains

			In all cases, the template has final authority over the final dimensions used for the table. The HL engine will suggestion a width that is usually appropriate, but the template is free to override that suggestion as it sees fit.

	~~There are~~ a ~~few situations where you~~

Rob: /* Width Control */

2008-11-20T07:03:15Z

Width Control

← Older revision		Revision as of 07:03, 20 November 2008
Line 32:		Line 32:
	If you actually set the template width to a new value, the HL engine honors that new width according to a few important rules.		If you actually set the template width to a new value, the HL engine honors that new width according to a few important rules.
	#If the table has only one column, the overall table width is changed to be based on the new width given by the template.		#If the table has only one column, the overall table width is changed to be based on the new width given by the template.
	#If the table has multiple columns, the new template width is used to determine how many columns can fit within the table - '''without''' increasing the established table width.		#If the table has multiple columns, the new template width is used to determine how many columns can actually fit within the table, '''without''' increasing the established table width. Once the number of columns is determined, the table width is changed to be exactly the space needed for those columns. Remember that a table will always be sized to contain at least one item, so setting a template width that is wider than the table width will increase the overall width of the table.
	##

	~~if multiple~~ columns, ~~existing~~ table width is ~~unchanged and new~~ template width is ~~used~~
	~~-number of columns is now based on how many columns can be fit in~~ the ~~space using the column~~ width ~~dictated by~~ the ~~template~~
	~~-final table~~ width ~~is based on integral fit~~ of the ~~width~~

	example 1		example 1

Rob: /* Width Control */

2008-11-20T05:43:29Z

Width Control

← Older revision		Revision as of 05:43, 20 November 2008
Line 31:		Line 31:

	If you actually set the template width to a new value, the HL engine honors that new width according to a few important rules.		If you actually set the template width to a new value, the HL engine honors that new width according to a few important rules.
			#If the table has only one column, the overall table width is changed to be based on the new width given by the template.
	if only one column, table width based ~~directly~~ on template width		#If the table has multiple columns, the new template width is used to determine how many columns can fit within the table - '''without''' increasing the established table width.
			##

	if multiple columns, existing table width is unchanged and new template width is used		if multiple columns, existing table width is unchanged and new template width is used

Rob: /* Width Control */

2008-11-20T05:27:53Z

Width Control

← Older revision		Revision as of 05:27, 20 November 2008
Line 29:		Line 29:

	In most cases, you will simply accept the width value specified by the table. This is achieved by using the default width that is setup for you and not specifying the width yourself. All of the table-based templates within the starting data files provided with the Kit, and even those within the Savage Worlds data files, simply use the default width given by the table.		In most cases, you will simply accept the width value specified by the table. This is achieved by using the default width that is setup for you and not specifying the width yourself. All of the table-based templates within the starting data files provided with the Kit, and even those within the Savage Worlds data files, simply use the default width given by the table.

			If you actually set the template width to a new value, the HL engine honors that new width according to a few important rules.

			if only one column, table width based directly on template width

			if multiple columns, existing table width is unchanged and new template width is used
			-number of columns is now based on how many columns can be fit in the space using the column width dictated by the template
			-final table width is based on integral fit of the width

			example 1
			if table is 400 pixels and has two columns, template starts with a width of 200
			if template sets width to 300, only one column will now fit
			table width is set to 300 pixels to correspond to the one column it contains

			example 2
			same starting state
			if template sets width to 150, three columns with now fit
			table width is set to 450 pixels to correspond to the three columns it contains



			There are a few situations where you

Rob: /* Width Control */

2008-11-20T05:18:19Z

Width Control

← Older revision		Revision as of 05:18, 20 November 2008
Line 24:		Line 24:
	==Width Control==		==Width Control==

	~~Secondly,~~ the table ~~dictates~~ the width of the template. ~~Table templates are always sized to span~~ the ~~full width~~ of the ~~table that contains them. The~~ template ~~contents do not need~~ to ~~be positioned to utilize~~ the ~~full width~~, ~~but~~ the ~~template itself~~ is always ~~sized to that width~~.		The handling of the width within table-based templates is significantly more interesting than the height. The width passes through many layers and is treated more as a suggestion than anything else when it is passed into the template. When the sizing invocation of the Position is triggered for a template, the width is initialized to a value that is based on sizing requests made upon the table portal itself within the layout. However, the final decision regarding the width is always at the discretion of the template.

	~~Only~~ the ~~height~~ of ~~a template is controlled by~~ the ~~template when within a table. Most tables have fixed-height items~~, ~~where~~ the ~~height~~ of ~~each item is always~~ the ~~same. For these tables~~, the ~~template is sized without any specific item before~~ the table ~~itself~~ is ~~sized~~. ~~Since no actual item is provided~~, the template ~~cannot base its height on the contents of the item. It must instead determine its size on general characteristics, such as font heights and other such information. Any attempt to set the height~~ to a ~~different in subsequent invocations of~~ the ~~Position script are ignored~~.		Upon entry to the sizing invocation of the Position script, the width is based on two factors. The total width of the table portal drives the overall width available, while the number of columns specified for the table dictates how the overall width is carved up. Using these two values, the template width is initialized to a value that evenly splits up the overall table width into columns.

	~~The exception to this~~ is ~~variable~~-~~height tables~~, ~~which are only supported for printed output. Within such tables~~, ~~each template has its height re-calculated for every item that is output~~.		In most cases, you will simply accept the width value specified by the table. This is achieved by using the default width that is setup for you and not specifying the width yourself. All of the table-based templates within the starting data files provided with the Kit, and even those within the Savage Worlds data files, simply use the default width given by the table.

Rob at 05:02, 20 November 2008

2008-11-20T05:02:21Z

← Older revision		Revision as of 05:02, 20 November 2008
Line 16:		Line 16:
	==Height Control==		==Height Control==

			The height of a template is always expected to be controlled by the template when within a table. Most tables contain fixed-height items, where the height of each item is always the same. For these tables, the template dimensions are expected to be established during the special "sizing" invocation of the Position script.

			During sizing, there is '''no''' specific item available to the template. The HL engine passes in a special, dummy item. This dummy item has values of zero for all numeric fields and values of the empty string ("") for all text-based fields. As a result, the template cannot base its height on the contents of an actual item. It must instead determine its size based on general characteristics, such as font heights and other such information.

			Once established during the sizing invocation, the height remains fixed. Any subsequent attempt to set the height to a different value are ignored. The exception to this is with variable-height tables, which are only supported for printed output. Within such tables, each template has its height re-calculated for every item that is output.

	==Width Control==		==Width Control==

Rob at 04:56, 20 November 2008

2008-11-20T04:56:25Z

← Older revision		Revision as of 04:56, 20 November 2008
Line 2:		Line 2:
	[Context: [[Home\|HL Kit]] [[Basic Concepts and Terminology]] [[Manipulation of Visual Elements]] [[Working With Tables]]]		[Context: [[Home\|HL Kit]] [[Basic Concepts and Terminology]] [[Manipulation of Visual Elements]] [[Working With Tables]]]

	==~~Template Sizing and Dimensions~~==		==Overview==

	Templates are normally sized ~~and positioned~~ either by the layout that contains them or by the template itself. ~~However,~~ templates used within tables are ~~handled a bit differently~~.		Templates are normally sized either by the layout that contains them or by the template itself. When templates are used within tables, the logic remains the same, but there are additional implications involved.

	~~First~~ of ~~all,~~ the ~~positioning~~ of a template within a table is ~~fixed~~. ~~The table has complete control over~~ the ~~positioning of each template~~ within it.		==Triggering of Position Script==

			The Position script of the template is invoked separately for each individual item being displayed. It is also invoked once when the table sizing process is first initiated. During this initial invocation is when the dimensions of the template are actually used by the containing table. No other positioning logic within the script is applied.

			During the initial sizing, you can use the "issizing" target reference to detect that state. When initial sizing is being performed, the template need only calculate its height and can bail out without doing anything else. Since any other script logic is going to be thrown away during the sizing operation, there is no need to perform it.

			You will see a check of the "issizing" target reference in most table-based templates within the starting data files provided by the Kit. If sizing is occurring, the script bails out as soon as the dimensions are calculated. While not truly necessary, it is recommended that you use the same technique within your own data files.

			==Height Control==


			==Width Control==

	Secondly, the table dictates the width of the template. Table templates are always sized to span the full width of the table that contains them. The template contents do not need to be positioned to utilize the full width, but the template itself is always sized to that width.		Secondly, the table dictates the width of the template. Table templates are always sized to span the full width of the table that contains them. The template contents do not need to be positioned to utilize the full width, but the template itself is always sized to that width.
Line 13:		Line 24:

	The exception to this is variable-height tables, which are only supported for printed output. Within such tables, each template has its height re-calculated for every item that is output.		The exception to this is variable-height tables, which are only supported for printed output. Within such tables, each template has its height re-calculated for every item that is output.

	The Position script of the template is invoked separately for each individual item being displayed. It is also invoked once when the table sizing process is initiated. During this initial sizing, you can use the "issizing" target reference to detect the state. When initial sizing is being performed, the template need only calculate its height and can bail out without doing anything else. Since any other script logic is going to be thrown away during the sizing operation, there is no need to perform it.

Rob at 04:46, 20 November 2008

2008-11-20T04:46:25Z

← Older revision		Revision as of 04:46, 20 November 2008
Line 1:		Line 1:
			[[Category:Basic Concepts and Terminology]]
			[Context: [[Home\|HL Kit]] [[Basic Concepts and Terminology]] [[Manipulation of Visual Elements]] [[Working With Tables]]]

	==Template Sizing and Dimensions==		==Template Sizing and Dimensions==

Rob: New page: ==Template Sizing and Dimensions== Templates are normally sized and positioned either by the layout that contains them or by the template itself. However, templates used within tables are...

2008-11-20T04:45:36Z

New page: ==Template Sizing and Dimensions== Templates are normally sized and positioned either by the layout that contains them or by the template itself. However, templates used within tables are...

New page

==Template Sizing and Dimensions==

Templates are normally sized and positioned either by the layout that contains them or by the template itself. However, templates used within tables are handled a bit differently.

First of all, the positioning of a template within a table is fixed. The table has complete control over the positioning of each template within it.

Secondly, the table dictates the width of the template. Table templates are always sized to span the full width of the table that contains them. The template contents do not need to be positioned to utilize the full width, but the template itself is always sized to that width.

Only the height of a template is controlled by the template when within a table. Most tables have fixed-height items, where the height of each item is always the same. For these tables, the template is sized without any specific item before the table itself is sized. Since no actual item is provided, the template cannot base its height on the contents of the item. It must instead determine its size on general characteristics, such as font heights and other such information. Any attempt to set the height to a different in subsequent invocations of the Position script are ignored.

The exception to this is variable-height tables, which are only supported for printed output. Within such tables, each template has its height re-calculated for every item that is output.

The Position script of the template is invoked separately for each individual item being displayed. It is also invoked once when the table sizing process is initiated. During this initial sizing, you can use the "issizing" target reference to detect the state. When initial sizing is being performed, the template need only calculate its height and can bail out without doing anything else. Since any other script logic is going to be thrown away during the sizing operation, there is no need to perform it.