Elements

element <Panel>
Namespace:
http://schema.caplin.com/CaplinTrader/webcentric
XML Representation Summary
<Panel
   
decorators
 = 
 xs:string
height
 = 
 xs:integer
width
 = 
 xs:integer
fixed_size
 = 
 xs:integer
maximized
 = 
 xs:boolean
minimized
 = 
 xs:boolean
padding
 = 
 xs:integer
style
 = 
 xs:string
defer
 = 
 xs:boolean : "false"
background
 = 
 xs:string
caption
 = 
 xs:string
img
 = 
 xs:string
rename
 = 
 xs:boolean
src
 = 
 xs:string
xml
 = 
 xs:string
xsl
 = 
 xs:string
/>
Parent elements (1):
Description
The Panel is a simple component into which local HTML content can be rendered. For embedding custom components (perhaps with external HTML content) a caplin:Panel should be used.
Attribute Detail
background
Type:
xs:string, predefined
Use:
optional
This hex color value defines the component's background colour.
caption
Type:
xs:string, predefined
Use:
optional
This is a short, descriptive piece of text which may be used by view for handle titles, tab text, and so on. It is best to keep this to just one or two words.
decorators
Type:
xs:string, predefined
Use:
optional
This value defines the id of the decorator to be applied on the Stack layout element. The decorator is defined separately in the Declarations section of the configuration.
defer
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
This attribute determines whether external content expressed with the 'src' attribute is pulled in on first use as opposed to at loadtime. The src attribute specifies a URL from which further XML layout can be loaded.
fixed_size
Type:
xs:integer, predefined
Use:
optional
This provides a hint to Webcentric that this frameItem should retain its significant size attribute (width or height, depending upon whether the frameset is a Terrace or Tower), even when the containing frameset is resized. If the frameset is a stack, no size attribute is significant, as all dimensions are dictated by the Stack itself. In an MDI frameset, both width and height are significant.
height
Type:
xs:integer, predefined
Use:
optional
This value normally determines the height of the element in pixels. However, if this component is a child of a Tower frameset, its height in pixels is determined by considering the other children of the Tower. Specifically, if the heights of all the children have been defined, then for each child the fraction calculated by dividing its height by the sum total of all the children's heights is multiplied by the vertical space in pixels to be filled by the Tower. This calculated value is the height in pixels for that child. If however, the heights of one or more of the other children have not been defined or, the value of the fixed_size attribute is 'true', then the height of this element will be the specified height in pixels and the other children will fill up the remaining space.
img
Type:
xs:string, predefined
Use:
optional
The URL for an image file. This should generally be a small image suitable for display: for example, within the handle or within a tab. A custom JavaScript View object would have to be written to access this stored URL and use it in the tabs, for example. The image cannot be used as a background image for the frame content.
maximized
Type:
xs:boolean, predefined
Use:
optional
Set this value to "true", if the frameItem should be displayed in the maximized state.
minimized
Type:
xs:boolean, predefined
Use:
optional
Set this value to "true", if the frameItem should be displayed in the minimized state.
padding
Type:
xs:integer, predefined
Use:
optional
The pixel value for the space left between the interior perimeter of a frameset and its children. The same effect can always be achieved with a Border, but padding is more efficient and uses less markup.
rename
Type:
xs:boolean, predefined
Use:
optional
When "true", an end-user can rename panels, otherwise they cannot. If this attribute is not specified, the value of the "panel_rename" attribute in the Application tag determines whether the panel can be renamed.
src
Type:
xs:string, predefined
Use:
optional
Specifies a file whose contents will be loaded at runtime and written into the content area of the Panel. The intended use is to load static html content into the panel.
style
Type:
xs:string, predefined
Use:
optional
This attribute allows for fine-grained control over the visual presentation aspects of components and decorators. Its value allows the element to be given a custom appearance or behavior via CSS or JavaScript respectively. In HTMLView, which is the base object for defining the HTML markup of components in the GUI, the value of the style attribute will be incorporated into the CSS class name of the rendered HTML object. In this way, custom visuals can be defined for this element in CSS. For example, using style="outer" in a Border element, results in the rendered HTML element having a class attribute of "Border_outer". CSS can then be applied to '.Border_outer', as opposed to the unmodified '.Border'. In JavaScript, a custom view implementation can be provided for a component or decorator. The name of the custom view object is HTML<ElementName>_<style>, where <style> is the value of this attribute and <ElementName> is the name of the element ('Border' or 'Tabstrip' for example). Methods on this view object can provide custom HTML construction mechanisms for the actual HTML components used in the element's display.
width
Type:
xs:integer, predefined
Use:
optional
This value normally determines the width of the element in pixels. However, if this component is a child of a Terrace frameset, its width in pixels is determined by considering the other children of the Terrace. Specifically, if the widths of all the children have been defined, then for each child the fraction calculated by dividing its width by the sum total of all the children's widths is multiplied by the horizontal space in pixels to be filled by the Terrace. This calculated value is the width in pixels for that child. If however, the widths of one or more of the other children have not been defined or, the value of the fixed_size attribute is 'true', then the width of this element will be the specified width in pixels and the other children will fill up the remaining space.
xml
Type:
xs:string, predefined
Use:
optional
Specifies an XML document to be loaded and stored as a property of the Panel. Usually this attribute is used in conjunction with the 'xsl' attribute. The XSLT stylesheet is applied to this XML file and the output from the transformation is written into the content area of the Panel. If no value is given in the xsl attribute, no processing is be performed on the XML file, and nothing is be written to the content area of the Panel. However, the XML data remains accessible via a property of the Panel through JavaScript.
xsl
Type:
xs:string, predefined
Use:
optional
Specifies an XSLT stylesheet to be applied either to the XML document specified in the src attribute, or to the XML persisted form of the contextNode. The output from the transformation is written into the content area of the Panel.