Elements

element <caplin:Dialog>
Namespace:
http://schema.caplin.com/CaplinTrader/caplinPanel
XML Representation Summary
<caplin:Dialog
   
background
 = 
 xs:string
caption
 = 
 xs:string
decorators
 = 
 xs:string
drop_target
 = 
 xs:string
force_open_size
 = 
 xs:boolean : "false"
handleContribs
 = 
 xs:string
height
 = 
 xs:integer
width
 = 
 xs:integer
hidden
 = 
 xs:boolean : "false"
id
 = 
 xs:string
identifier
 = 
 xs:string
maximized
 = 
 xs:boolean
minimized
 = 
 xs:boolean
pkey
 = 
 xs:string
recycle
 = 
 xs:boolean : "false"
singleton
 = 
 xs:string
dialog
 = 
 xs:boolean
position
 = 
 xs:string
/>
Parent elements (1):
Description
A caplin:Dialog is a special type of rectangular layout component, the behaviour of which is a floating window displayed on top of the application layout, rather than a Panel which snaps to form a part of the layout. This element has the same attributes as a caplin:Panel, however the "dialog" attribute nust be set to "true".
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:
required
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 this layout element. The decorator is defined separately in the Declarations section of the configuration.
dialog
Type:
xs:boolean, predefined
Use:
required
"True" when the layout component is a floating dialog rather than a panel.
drop_target
Type:
xs:string, predefined
Use:
optional
If this attribute is set to 'SNAP_FRAMEITEM' then other components being dragged can be dropped onto this decorator or component.
force_open_size
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
When this is set to "true"it causes the panel to act as though it has a fixed size when it is initially loaded, but allows for it to be resized later.
handleContribs
Type:
xs:string, predefined
Use:
optional
This value defines the id of the HandleContribs tag, the contents of which are to be applied on the Panel's handle if a Handle decorator is also applied.
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.
hidden
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
This value is set to "true" if the panel contains a component which should be loaded when the application loads, but does not need to show in the layout. The panel can be made visible in the layout by making use of the <showComponent> action. This attribute is useful for loading components that need to be functioning all the time that the application is running. Examples are console panels, such as for price alerts or logging.
id
Type:
xs:string, predefined
Use:
optional
A unique id for the component.
identifier
Type:
xs:string, predefined
Use:
optional
Used as a (non-unique) general purpose way of distinguishing and selecting nodes. It is not currently used to cache nodes, as is the id attribute, so confers no performance benefit when searching the model.
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.
pkey
Type:
xs:string, predefined
Use:
optional
This value of this attribute determines whether the component within the panel is visible for end-users based on their individual permissions. Given that the application is integrated with Caplin's Permissioning subsystem in the Integration Suite, the value of this attribute can be set to a permission that needs to be checked when a user is using the application, before the component is rendered on screen.
position
Type:
xs:string, predefined
Use:
optional
The only supported option at moment is CENTER. This attribute is useful for positioning a dialog in the centre of the the layout when it is opened.
recycle
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
If true, the presentation model and view for this component will be preserved after disposal (ie when closed) and re-used when a subsequent request for the same type of component is received. It is the responsibility of the component implementation to perform any necessary re-initialisation of the view structure.
singleton
Type:
xs:string, predefined
Use:
optional
Determines how and if the framework creates new instances of the panel. Valid values are "instance" and "type". Works with the identifier attribute to ensure that only a single instance of this component with this identifier may be present at any one time within the application. If the same component is included in multiple layouts, the same component instance will be used. In the case of Dialogs (the most common usage for this attribute) a showDialog action for a dialog already displaying will bring that dialog to the foreground, rather than create a new instance. 'type' is used to ensure that only one instance of a particular component type can be used at any one time. Therefore, it's an error to include more than one such component within a single layout.
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 another 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.