Style Element (Data)

Context: HL Kit … Kit Reference … Structural File Reference 

The "style" Element

All of the basic visual look and behaviors of portals is encapsulated in a collection of styles. Each distinct category of portal has its own type of style, and you can only associate styles with portals of the corresponding type. Each separate style is specified through the use of a "style" element. The complete list of attributes for this element is below.

id	Id – Specifies the unique id of the style. This id is used in all references to the style.
border	(Optional) Id – Identifies the border to used in conjunction with this style. All portals may have a border drawn around them, and the border is controlled via the style. You can specify the unique id of the border to use or "none" to indicate no border. Default: "none"

The "resource" element also possesses child elements that define the specifics of the resource. The list of these child elements is below and must appear in the order shown. Click on the link to access the details for each element.

IMPORTANT! With the exception of the "resource" element, exactly one of these child elements may be specified for each style. If multiple are given, a compiler error will be reported. The chosen child element dictates the type of style that is being defined. You may include as many "resource" elements as you wish after the single child element that specifies the style.

style_label	An optional "style_label" element may appear as defined by the given link. This element specifies the details of a style for use with label portals.
style_image	An optional "style_image" element may appear as defined by the given link. This element specifies the details of a style for use with image portals.
style_edit	An optional "style_edit" element may appear as defined by the given link. This element specifies the details of a style for use with edit portals.
style_checkbox	An optional "style_checkbox" element may appear as defined by the given link. This element specifies the details of a style for use with checkbox portals.
style_menu	An optional "style_menu" element may appear as defined by the given link. This element specifies the details of a style for use with menu portals.
style_action	An optional "style_action" element may appear as defined by the given link. This element specifies the details of a style for use with action portals.
style_incrementer	An optional "style_incrementer" element may appear as defined by the given link. This element specifies the details of a style for use with incrementer portals.
style_chooser	An optional "style_chooser" element may appear as defined by the given link. This element specifies the details of a style for use with chooser portals.
style_region	An optional "style_region" element may appear as defined by the given link. This element specifies the details of a style for use with region portals.
style_table	An optional "style_table" element may appear as defined by the given link. This element specifies the details of a style for use with table portals.
style_separator	An optional "style_separator" element may appear as defined by the given link. This element specifies the details of a style for use with separator portals.
style_special	An optional "style_special" element may appear as defined by the given link. This element specifies the details of a style for use with special portals.
style_output	An optional "style_output" element may appear as defined by the given link. This element specifies the details of a style for use with output portals.
resource	Zero or more "resource" elements may appear as defined by the given link. This element specifies new resources that are used in conjunction with the style.

Colors in Styles

Many styles allow you to directly specify a color value in the format "xxxxxx". The format for the color uses standard HTML color syntax, with each character representing a hexadecimal digit. The first two characters define the Red color value, the next two Green, and the last two Blue. For example, the color "ff0080" specifies a Red value of "ff", a Green value of "00", and a Blue value of "80".

For additional details on specifying colors via the HTML syntax, please refer to one of the many websites that provide this information, such as http://www.w3schools.com/Html/html_colors.asp.

Scaling of Images

When encoded text is supported within a category of portal, you will typically be given control over the scaling of images within the corresponding style. When enabled, image scaling is applied to all bitmaps that are inserted into the encoded text that is rendered into the portal. The scaling ratio is based on the difference between the initial font size for the portal and the current font size at which the text is now being rendered. Scaling is valuable for when you want to ensure that the bitmaps remain proportionally sized relative to the font size of the text, which is important when text and bitmaps are interleaved within the encoded text.

The "style_label" Element

The "style_label" element defines the facets of a style for label portals. The complete list of attributes for this element is below.

font	Id – Unique id of the font resource to be used for the style.
textcolor	(Optional) Text – Color value to be used for drawing text in the format "xxxxxx" (see above). If omitted, the "textcolorid" attribute must be specified. Default: Empty.
textcolorid	(Optional) Id – Unique id of the color resource to be used for drawing text. If omitted, the "textcolor" attribute must be specified. Default: Empty.
background	(Optional) Id – Unique id of the bitmap resource to use as the background. If omitted, the text is drawn transparently on the existing background region. Default: Empty.
alignment	(Optional) Set – Specifies how the text should be horizontally aligned within the portal width. Must be one of these values: left – Text is left-aligned. center – Text is centered within the portal. right – Text is right-aligned. Default: "left".
ispattern	(Optional) Boolean – Indicates whether the background bitmap should be centered within the portal dimensions or tiled to fill the entire portal. Default: "no".
scaleimage	(Optional) Boolean – Indicates whether bitmaps included within encoded text are scaled (see above). Default: "yes".

The "style_image" Element

The "style_image" element defines the facets of a style for image portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_edit" Element

The "style_edit" element defines the facets of a style for edit portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_checkbox" Element

The "style_checkbox" element defines the facets of a style for checkbox portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_menu" Element

The "style_menu" element defines the facets of a style for menu portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_action" Element

The "style_action" element defines the facets of a style for action portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_incrementer" Element

The "style_incrementer" element defines the facets of a style for incrementer portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_chooser" Element

The "style_chooser" element defines the facets of a style for chooser portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_region" Element

The "style_region" element defines the facets of a style for region portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_table" Element

The "style_table" element defines the facets of a style for table portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_separator" Element

The "style_separator" element defines the facets of a style for separator portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_special" Element

The "style_special" element defines the facets of a style for special portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

The "style_output" Element

The "style_output" element defines the facets of a style for output portals. The complete list of attributes for this element is below.

	Id – Unique id of the font resource to be used for the style.
	(Optional) x –
	(Optional) x –
	(Optional) x –

Example

The following example demonstrates what various "style" elements might look like. All default values are assumed for optional attributes.