Using Automatic Placement - Revision history

Colen at 05:25, 20 December 2013

2013-12-20T05:25:16Z

← Older revision		Revision as of 05:25, 20 December 2013
Line 3:		Line 3:
	==Overview==		==Overview==

	In an effort to make things as easy as possible, the Kit provides a mechanism called "automatic placement" that makes positioning certain visual elements significantly easier. Although primarily intended for use within sheets, automatic placement can also be used in various places with on-screen visual elements.		In an effort to make things as easy as possible, the Kit provides a mechanism called "automatic placement" that makes positioning certain visual elements significantly easier. Although primarily intended for use within sheets, automatic placement can also be used in various places with on-screen visual elements. The [[Using Batch Placement\|batch placement]] mechanism is typically a better choice for on-screen visual elements.

	Automatic placement can only be used on visual elements within layouts and scenes. Each of these element types manages internal logic to support automatic placement, so you can use the mechanism whenever it suits your needs. Automatic placement assumes that you are placing a progression of visual elements in a vertical arrangement, with each successive element appearing beneath the previous element. Consequently, the mechanism lends itself best to printed output, but it can also come in handy for on-screen positioning.		Automatic placement can only be used on visual elements within layouts and scenes. Each of these element types manages internal logic to support automatic placement, so you can use the mechanism whenever it suits your needs. Automatic placement assumes that you are placing a progression of visual elements in a vertical arrangement, with each successive element appearing beneath the previous element. Consequently, the mechanism lends itself best to printed output, but it can also come in handy for on-screen positioning.

Rob: /* The Rules */

2009-02-20T02:23:34Z

The Rules

← Older revision		Revision as of 02:23, 20 February 2009
Line 27:		Line 27:
	#When automatic placement attempts to place a visual element that will not fully fit in the remaining space, the region is considered to be fully utilized and no further elements will be placed.		#When automatic placement attempts to place a visual element that will not fully fit in the remaining space, the region is considered to be fully utilized and no further elements will be placed.
	#If a table is placed and it does not fully fit in the remaining space, as many items as will fit are output. If the table is within a sheet, all remaining items are treated as "spillover" for output in subsequent tables. If within a panel, the table is assumed to provide scrolling to view the excess items.		#If a table is placed and it does not fully fit in the remaining space, as many items as will fit are output. If the table is within a sheet, all remaining items are treated as "spillover" for output in subsequent tables. If within a panel, the table is assumed to provide scrolling to view the excess items.
	#Any visual element that is not displayed at all within the region is designated as non-visible. This means that any table that contains zero items is declared non-visible. Similarly, any templates and/or layouts that do not fully fit are deemed non-visible.		#Any visual element that is not displayed at all within the region is designated as non-visible. This means that any table that contains zero items is declared non-visible. Similarly, any templates and/or layouts that do not fully fit are deemed non-visible. {{important}}The key exception to this rule is dynamic and auto tables. Since these tables must allow the user to add items to them at all times, they are always shown even when they contain zero items.
	#Until at least one visual element with actual contents is successfully placed within the region, the gap is always considered to be zero. This ensures that the first item actually placed in the container always starts at the top, regardless of how many elements render no contents.		#Until at least one visual element with actual contents is successfully placed within the region, the gap is always considered to be zero. This ensures that the first item actually placed in the container always starts at the top, regardless of how many elements render no contents.

Rob at 08:38, 22 November 2008

2008-11-22T08:38:56Z

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

	==Overview==		==Overview==

Rob: /* How It Works */

2008-11-21T00:53:40Z

How It Works

← Older revision		Revision as of 00:53, 21 November 2008
Line 10:		Line 10:
	==How It Works==		==How It Works==

	All placement is performed within a rectangular region. Before anything is placed, the bounds of this region are initialized to be the full height and width of the visual container (i.e. the layout~~, panel,~~ or ~~sheet~~). When placement begins, each new placement consumes vertical space within the region. This automatically shrinks the region, moving the top of the region downward to the bottom of each new visual element that is placed.		All placement is performed within a rectangular region. Before anything is placed, the bounds of this region are initialized to be the full height and width of the visual container (i.e. the layout or scene). When placement begins, each new placement consumes vertical space within the region. This automatically shrinks the region, moving the top of the region downward to the bottom of each new visual element that is placed.

	Automatic placement is performed via the "autoplace" target reference. Each placement can specify a gap that should appear between the new element and the one previously placed. Additional target references provide the author with complete control over the bounds of the region within which automatic placement is performed. This makes it possible to place specific elements at the top and/or bottom of the visual container, then adjust the automatic placement region accordingly, and finally perform automatic placement of the remaining visual elements. You can also place elements automatically and then retrieve the bounds of the remaining unused space, in which you can manually place visual elements.		Automatic placement is performed via the "autoplace" target reference. Each placement can specify a gap that should appear between the new element and the one previously placed, which enables appropriate spacing between visual elements.

			Additional target references provide the author with complete control over the bounds of the region within which automatic placement is performed. This makes it possible to place specific elements at the top and/or bottom of the visual container, then adjust the automatic placement region accordingly, and finally perform automatic placement of the remaining visual elements. You can also place elements automatically and then retrieve the bounds of the remaining unused space, after which you can manually place visual elements in that space.

	==The Rules==		==The Rules==

Rob: /* Overview */

2008-11-21T00:51:09Z

Overview

← Older revision		Revision as of 00:51, 21 November 2008
Line 6:		Line 6:
	In an effort to make things as easy as possible, the Kit provides a mechanism called "automatic placement" that makes positioning certain visual elements significantly easier. Although primarily intended for use within sheets, automatic placement can also be used in various places with on-screen visual elements.		In an effort to make things as easy as possible, the Kit provides a mechanism called "automatic placement" that makes positioning certain visual elements significantly easier. Although primarily intended for use within sheets, automatic placement can also be used in various places with on-screen visual elements.

	Automatic placement can only be used on visual elements within layouts~~, panels,~~ and ~~sheets~~. ~~Every one~~ of these element types manages internal logic to support automatic placement, so you can use the mechanism whenever it suits your needs. Automatic placement assumes that you are placing a progression of visual elements in a vertical arrangement, with each successive element appearing beneath the previous element.		Automatic placement can only be used on visual elements within layouts and scenes. Each of these element types manages internal logic to support automatic placement, so you can use the mechanism whenever it suits your needs. Automatic placement assumes that you are placing a progression of visual elements in a vertical arrangement, with each successive element appearing beneath the previous element. Consequently, the mechanism lends itself best to printed output, but it can also come in handy for on-screen positioning.

	==How It Works==		==How It Works==

Rob at 12:42, 20 November 2008

2008-11-20T12:42:53Z

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

			==Overview==

	In an effort to make things as easy as possible, the Kit provides a mechanism called "automatic placement" that makes positioning certain visual elements significantly easier. Although primarily intended for use within sheets, automatic placement can also be used in various places with on-screen visual elements.		In an effort to make things as easy as possible, the Kit provides a mechanism called "automatic placement" that makes positioning certain visual elements significantly easier. Although primarily intended for use within sheets, automatic placement can also be used in various places with on-screen visual elements.

	Automatic placement can only be used on visual elements within layouts, panels, and sheets. Every one of these element types manages internal logic to support automatic placement, so you can use the mechanism whenever it suits your needs. Automatic placement assumes that you are placing a progression of visual elements in a vertical arrangement, with each successive element appearing beneath the previous element.		Automatic placement can only be used on visual elements within layouts, panels, and sheets. Every one of these element types manages internal logic to support automatic placement, so you can use the mechanism whenever it suits your needs. Automatic placement assumes that you are placing a progression of visual elements in a vertical arrangement, with each successive element appearing beneath the previous element.

			==How It Works==

	All placement is performed within a rectangular region. Before anything is placed, the bounds of this region are initialized to be the full height and width of the visual container (i.e. the layout, panel, or sheet). When placement begins, each new placement consumes vertical space within the region. This automatically shrinks the region, moving the top of the region downward to the bottom of each new visual element that is placed.		All placement is performed within a rectangular region. Before anything is placed, the bounds of this region are initialized to be the full height and width of the visual container (i.e. the layout, panel, or sheet). When placement begins, each new placement consumes vertical space within the region. This automatically shrinks the region, moving the top of the region downward to the bottom of each new visual element that is placed.
Line 10:		Line 14:
	Automatic placement is performed via the "autoplace" target reference. Each placement can specify a gap that should appear between the new element and the one previously placed. Additional target references provide the author with complete control over the bounds of the region within which automatic placement is performed. This makes it possible to place specific elements at the top and/or bottom of the visual container, then adjust the automatic placement region accordingly, and finally perform automatic placement of the remaining visual elements. You can also place elements automatically and then retrieve the bounds of the remaining unused space, in which you can manually place visual elements.		Automatic placement is performed via the "autoplace" target reference. Each placement can specify a gap that should appear between the new element and the one previously placed. Additional target references provide the author with complete control over the bounds of the region within which automatic placement is performed. This makes it possible to place specific elements at the top and/or bottom of the visual container, then adjust the automatic placement region accordingly, and finally perform automatic placement of the remaining visual elements. You can also place elements automatically and then retrieve the bounds of the remaining unused space, in which you can manually place visual elements.

	In general, automatic placement is very easy to use and very intuitive in how it handles various situations. However, in the interest of clarity, the following ~~are the~~ specific rules ~~that~~ govern how automatic placement behaves.		==The Rules==

			In general, automatic placement is very easy to use and very intuitive in how it handles various situations. However, in the interest of clarity, the following specific rules govern how automatic placement behaves.

	#When an element is automatically placed, the width of that element is set to the width of the automatic placement region for the visual container. In other words, each element is sized to take up the full width of the container.		#When an element is automatically placed, the width of that element is set to the width of the automatic placement region for the visual container. In other words, each element is sized to take up the full width of the container.

Rob at 12:40, 20 November 2008

2008-11-20T12:40:53Z

← Older revision		Revision as of 12:40, 20 November 2008
Line 18:		Line 18:
	##Since the height is set to the full region during automatic placement, it is assumed that every visual element being placed will properly truncate its height as part of its rendering. For example, a template placed within a layout or a layout placed within a sheet must properly set its height at the end of the Position script, basing the height on the extent of the bottommost item within the element.		##Since the height is set to the full region during automatic placement, it is assumed that every visual element being placed will properly truncate its height as part of its rendering. For example, a template placed within a layout or a layout placed within a sheet must properly set its height at the end of the Position script, basing the height on the extent of the bottommost item within the element.
	##Table portals automatically determine their extent, so automatic placement of tables works smoothly, without the need for any special handling.		##Table portals automatically determine their extent, so automatic placement of tables works smoothly, without the need for any special handling.
			#When automatic placement attempts to place a visual element that will not fully fit in the remaining space, the region is considered to be fully utilized and no further elements will be placed.
			#If a table is placed and it does not fully fit in the remaining space, as many items as will fit are output. If the table is within a sheet, all remaining items are treated as "spillover" for output in subsequent tables. If within a panel, the table is assumed to provide scrolling to view the excess items.
	Until at least one visual element with actual contents is successfully placed within the container, the gap is always considered to be zero. This ensures that the first item actually placed in the container always starts at the top, regardless of how many elements render no contents.		#Any visual element that is not displayed at all within the region is designated as non-visible. This means that any table that contains zero items is declared non-visible. Similarly, any templates and/or layouts that do not fully fit are deemed non-visible.
			#Until at least one visual element with actual contents is successfully placed within the region, the gap is always considered to be zero. This ensures that the first item actually placed in the container always starts at the top, regardless of how many elements render no contents.



	-When automatic placement ~~attempt~~ to place a visual element that will not
	fully fit in the remaining space, the region is considered to be fully
	utilized and no further elements ~~can~~ be placed
	-If a table is placed and it does not fully fit in the remaining space, as
	many items as will fit are output, ~~with~~ all remaining items ~~being~~ treated
	as "spillover" for ~~rendering~~ in subsequent tables
	-Any visual element that is not displayed at all is designated as non-visible
	~~-Tables~~ that ~~contain~~ zero items ~~are~~ non-visible
	~~-Templates~~ and ~~layout~~ that do not fully fit are non-visible

Rob at 12:35, 20 November 2008

2008-11-20T12:35:43Z

@@ Line 10: / Line 10: @@
 Automatic placement is performed via the "autoplace" target reference. Each placement can specify a gap that should appear between the new element and the one previously placed. Additional target references provide the author with complete control over the bounds of the region within which automatic placement is performed. This makes it possible to place specific elements at the top and/or bottom of the visual container, then adjust the automatic placement region accordingly, and finally perform automatic placement of the remaining visual elements. You can also place elements automatically and then retrieve the bounds of the remaining unused space, in which you can manually place visual elements.
+#When an element is automatically placed, the width of that element is set to the width of the automatic placement region for the visual container. In other words, each element is sized to take up the full width of the container.
@@ Line 19: / Line 25: @@
      -When automatic placement attempt to place a visual element that will not
          fully fit in the remaining space, the region is considered to be fully

Rob at 12:25, 20 November 2008

2008-11-20T12:25:08Z

← Older revision		Revision as of 12:25, 20 November 2008
Line 8:		Line 8:
	All placement is performed within a rectangular region. Before anything is placed, the bounds of this region are initialized to be the full height and width of the visual container (i.e. the layout, panel, or sheet). When placement begins, each new placement consumes vertical space within the region. This automatically shrinks the region, moving the top of the region downward to the bottom of each new visual element that is placed.		All placement is performed within a rectangular region. Before anything is placed, the bounds of this region are initialized to be the full height and width of the visual container (i.e. the layout, panel, or sheet). When placement begins, each new placement consumes vertical space within the region. This automatically shrinks the region, moving the top of the region downward to the bottom of each new visual element that is placed.

	Automatic placement is performed via the "autoplace" target reference. Each placement can specify a gap that should appear between the new element and the one previously placed.		Automatic placement is performed via the "autoplace" target reference. Each placement can specify a gap that should appear between the new element and the one previously placed. Additional target references provide the author with complete control over the bounds of the region within which automatic placement is performed. This makes it possible to place specific elements at the top and/or bottom of the visual container, then adjust the automatic placement region accordingly, and finally perform automatic placement of the remaining visual elements. You can also place elements automatically and then retrieve the bounds of the remaining unused space, in which you can manually place visual elements.





			Until at least one visual element with actual contents is successfully placed within the container, the gap is always considered to be zero. This ensures that the first item actually placed in the container always starts at the top, regardless of how many elements render no contents.




	~~-Additional target references provide an author with complete control over~~
	~~the bounds of the region within which automatic placement is performed~~
	~~-Set these characteristics before using "autoplace" if you need to first~~
	~~manually position certain elements~~
	~~-Get these characteristics after using "autoplace" if you need to~~
	~~manually position elements in the space remaining, or if you need to~~
	~~determine the extent of the elements that were placed~~
	~~-"autoleft", "autotop", "autoright", and "autobottom" provide read/write~~
	~~access to the bounds of the region used for automatic placement~~
	~~-"autowidth" and "autoheight" provide read/write access to the dimensions~~
	~~-They default to the full width of the visual container~~
	-When an element is automatically placed, the width of that element is set		-When an element is automatically placed, the width of that element is set
	to the "autowidth" of the visual container		to the "autowidth" of the visual container
	-When a template is automatically placed, it is rendered upon completion		-When a template is automatically placed, it is rendered upon completion
	-When a layout is automatically placed, it is estimated upon completion		-When a layout is automatically placed, it is estimated upon completion
	~~-Until at least one visual element with actual contents is successfully~~
	~~placed within the container, the gap is always considered to be zero~~
	~~-This ensures that the first item actually placed in the container always~~
	~~starts at the top, regardless of how many elements render no contents~~
	-When automatically placed, most visual elements have their height set to the		-When automatically placed, most visual elements have their height set to the
	full remaining height of the automatic placement region		full remaining height of the automatic placement region

Rob at 12:20, 20 November 2008

2008-11-20T12:20:17Z

← Older revision		Revision as of 12:20, 20 November 2008
Line 6:		Line 6:
	Automatic placement can only be used on visual elements within layouts, panels, and sheets. Every one of these element types manages internal logic to support automatic placement, so you can use the mechanism whenever it suits your needs. Automatic placement assumes that you are placing a progression of visual elements in a vertical arrangement, with each successive element appearing beneath the previous element.		Automatic placement can only be used on visual elements within layouts, panels, and sheets. Every one of these element types manages internal logic to support automatic placement, so you can use the mechanism whenever it suits your needs. Automatic placement assumes that you are placing a progression of visual elements in a vertical arrangement, with each successive element appearing beneath the previous element.

	~~-Visual elements can utilize~~ the ~~"autoplace" target reference for quick~~ and ~~easy~~		All placement is performed within a rectangular region. Before anything is placed, the bounds of this region are initialized to be the full height and width of the visual container (i.e. the layout, panel, or sheet). When placement begins, each new placement consumes vertical space within the region. This automatically shrinks the region, moving the top of the region downward to the bottom of each new visual element that is placed.
	placement of ~~those elements~~
	~~-Syntax~~ is "autoplace~~[gap]", where~~ "gap~~" is the vertical gap~~ between the new		Automatic placement is performed via the "autoplace" target reference. Each placement can specify a gap that should appear between the new element and the one previously placed.
	element ~~being placed~~ and the ~~bottom of the previous element that was~~
	~~automatically placed~~


	-Additional target references provide an author with complete control over		-Additional target references provide an author with complete control over
	the bounds of the region within which automatic placement is performed		the bounds of the region within which automatic placement is performed
Line 22:		Line 24:
	-"autowidth" and "autoheight" provide read/write access to the dimensions		-"autowidth" and "autoheight" provide read/write access to the dimensions
	-They default to the full width of the visual container		-They default to the full width of the visual container
	~~-Before anything is placed, the bounds of the region are initialized to be~~
	~~the full height and width of the visual container (i.e. layout or scene)~~
	-When an element is automatically placed, the width of that element is set		-When an element is automatically placed, the width of that element is set
	to the "autowidth" of the visual container		to the "autowidth" of the visual container
	~~-After an element is automatically placed, the "top" edge of the region is~~
	~~moved downward to the bottom of the placed visual element~~
	-When a template is automatically placed, it is rendered upon completion		-When a template is automatically placed, it is rendered upon completion
	-When a layout is automatically placed, it is estimated upon completion		-When a layout is automatically placed, it is estimated upon completion