Component SIZETRANSFER

Overview

The SIZETRANSFER component is an invisible component that is positioned inside a PANE.

Every time the PANE changes its size (either due to user activity or due to internal rearrangements), this SIZETRANSFER component will get notified. The component then writes the size of the PANE into the SIZEVALUE-property.

The format, that is used is "<x-size>;<y-size>".

There are two types of passing the sizes:

1. By default sizes are transferred as pixel sizes, separated by a semicolon. Example: the value "300;200" means a width of 300 and a height of 200 pixels.

2. You also can pass the size as size categories. To do so you need to define the attributes HORIZONTALCATEGORIES and/or VERTICALCATEGORIES.

Categories are an abstraction of pixel sizes. You may e.g. define a category-definition of "narrow:400;normal:800;wide:1200". In this case the screen size is passed as corresponding category value (and not as pixel value).

Please pay attention: a change of a PANE's size is not directly transferred to the server side. As with e.g. FIELD-input it is "parked" on client side and is then waiting for the next roundtrip. If you want the size to be transferred immediately then you need to define FLUSH as "true".

Attribute summary

Typically used attributes

All attributes are

General attributes are

Positioning

Used inside: ADAPTIVEAREAITEM, BOX, PANE, SCROLLPANE

Attribute details

actionListener

Binding to server side method that processes the events coming from this component.

#{methodBinding}Method binding

adapterbinding

Special binding to component adapter object instance on server side. The component adapter must be an instance of IComponentAdapterBinding. For some components (e.g. FIXGRID) there is an extended interface (e.g. IFIXGRIDComponentAdapterBinding).

#{tobedefined}Binding to IComponentAdapter instance

attributemacro

Name of macro that is used for generating certain attributes of this component. Please pay attention: the value of this attribute is read one time for each control and cannot be changed afterwards.

comment

Comment that can be asigned to any component. The comment is not operationally used.

Any textAny text

configinfo

Configuration information that is attached to this component. This information is not functionally used by CaptainCasa, but may be used for any application specific purpose.

flush

Indicator if data changed in the component are transferred immediately to the server, causing a normal round trip processing from client to server.

trueFlush is done on data change.
falseNo flush. Data is transferred to server with next round trip.

flushtimer

Used in addition to FLUSH attribute. Defines the number of milliseconds after which the component automatically flushs to the server. You need to set FLUSH=true in addition.

 No flush timer (default)
10001000 milliseconds
20002000 milliseconds

horizontalcategories

Sizing categroies for adaptive behavior

SMALL:500;MEDIUM:1000;LARGE:100000SMALL up to 500 pixels, MEDIUM up to 1000 pixels, LARGE above

rendered

Flag that indicated if this component is rendered at all. If set to false then the component is not rendered - there is no component data sent to the client.

trueComponent is rendered (default)
falseComponent is not rendered

sizevalue

This is the binding to the String-property into which the size of the corresponding pane is transferred. The size is transferred in the format width;height e.g. 200;100. The values are scaled pixel values.

stylevariant

In CaptainCasa you can define styles definitions for components. A style definition is a definition of a set of default attribute values that are applied to the component. In case you want to differenciate between different usage types of the component you can apply multiple styles - and use the stylevariant attribute to select between.

verticalcategories