Component BLOCKABLEAREA

Overview

The BLOCKABLEAREAE is a rectangular area containing any components. When setting attribute BLOCKED to "true" then the whole interaction in the are is blocked, so the user cannot use any component inside the area.

Typical use case: you want to block some background area until some user activity in a foreground area is finished by the user.

Attribute summary

Typically used attributes

All attributes are

Positioning

Used inside: ADAPTIVETILECONTAINER, ADAPTIVETOOLBAR, AREASELECTOR, BLOCKABLEAREA, BUTTONPOPUP, COLSYNCHEDROW, CUBEROTATOR, DRAWAREA, FLYINCONTENTAREA, FOLDABLEPANEHEADERROW, GRIDHEADERLABEL, GRIDLAYOUTROW, HIDEABLE, LABELCONTAINER, LAYEREDPANE, OVERLAYAREABASEITEM, OVERLAYAREAITEM, PAGEBEANROOT, PAINTAREAITEM, REPEAT, ROTATECONTENTAREA, ROW, ROWADAPTIVELINE, ROWFLEXCOLUMNCONTAINER, ROWFLEXLINECONTAINER, ROWFOOTER, ROWHEADER, ROWMATRIXAREA, ROWTITLEBAR, SCALEPANE, SCHEDULEITEM, SCHEDULEITEMAREA, SHIFTCONTAINER, SIZEANIMATIONAREA, STABLEAREA, STABLEAREACONFIGAREA, TABBEDAREABEGIN, TABBEDAREAEND, TEXTWITHCONTROLS, TREENODE

Using inside: ACTIVEX, ADAPTIVEGRIDLAYOUTPANE, ADAPTIVESPLITAREA, ADAPTIVETILECONTAINER, ADAPTIVETOOLBAR, ANIMATEDPANE, ANIMATEICON, AREASELECTOR, ARRAYGRID, AUTOCOMPLETE, AVATARICON, AWESOMEFONTICON, BLOCKABLEAREA, BOX, BROWSER, BUTTON, BUTTONCOPYPASTEACTIVATION, BUTTONMENU, BUTTONPOPUP, BUTTONPOPUPMENU, BUTTONVERTICAL, CALENDAR, CALENDARFIELD, CAMERA, CAMERARECORDER, CHARTJS, CHECKBOX, CLIENTFILEEXPLORER, CLOCK, CODEEDITOR, COLDISTANCE, COLLINE, COLORFIELD, COLORICON, COLSYNCHEDPANE, COMBOBOX, COMBOFIELD, CUBEROTATOR, DIRECTHTMLINSERT, DRAWAREA, DYNAMICCONTENT, FIELD, FILECHOOSER, FILEDOWNLOADBUTTON, FILEDOWNLOADLINK, FILEUPLOAD, FILEUPLOADBUTTON, FILEUPLOADBUTTONASYNCHRONOUS, FILEUPLOADLINK, FILEUPLOADLINKASYNCHRONOUS, FIXGRID, FIXGRIDTOUCHBUTTON, FIXGRIDWITHGROUPING, FLYINCONTENTAREA, FOLDABLEPANE, FOLDABLEPOPUPINCLUDE, FOLDABLEVERTICALPANE, FONTICON, FORMATTEDFIELD, FULLSCREENBUTTON, FXCHART, GRIDHEADERLABEL, GRIDLAYOUTPANE, HELPICON, HEXIMAGE, HEXIMAGEMAP, HIDEABLE, HYPERLINK, ICON, ICONSEPTEXT, IFRAMEINCLUDE, IMAGE, IMAGEANONYMIZER, IMAGEANONYMIZERDIRECT, IMAGEMAP, IMAGESHAKER, JRVIEWER, KEYBOARDSCANNER, KEYSELECTOR, LABEL, LABELCONTAINER, LABELMULTILINE, LABELVERTICAL, LAYEREDPANE, LINK, LINKVERTICAL, LIST, LONGTEXTFIELD, MEDIAPLAYER, MENUBAR, MULTILABEL, OSMVIEWER, OUTLOOKBAR, OVERLAYAREA, PAGEBEANCOMPONENT, PAGEBEANINCLUDE, PAINTAREA, PANE, PARENTEXIT, PASSWORD, PDFRENDERER, PDFRENDERERVIAURL, PICKLIST, POOLEDBROWSER, PROGRESSBAR, QRCODESCANNERJSQR, RADIAL, RADIOBUTTON, RADIOBUTTONGROUP, REPEAT, RGRAPH, ROLLINGCONTAINERAREA, ROTATECONTENTAREA, SCALEPANE, SCANFIELD, SCENEJS, SCHEDULE, SCROLLANCHOR, SCROLLBAR, SCROLLNOTIFIER, SCROLLPANE, SHIFTCONTAINER, SIMPLEHTMLEDITOR, SIZEABLEPANE, SIZEABLEPANEHORIZONTAL, SIZEANIMATIONAREA, SLIDECONTAINER, SLIDER, SLIDERRANGE, SMARTLABEL, SMARTTEXTAREA, SPANGRID, SPINNER, SPLITPANE, STABLEAREAMANAGER, STABLEAREAPLACEHOLDER, SUBPAGE, SVGVIEWER, SYSTEMICON, TABBEDLINE, TABBEDLINECONTAINER, TABBEDLINEVERTICAL, TABBEDPANE, TEXTAREA, TEXTAREAWITHCOMMENT, TEXTEDITOR, TEXTPANE, TEXTPANEVERTICAL, TEXTWITHCONTROLS, TEXTWITHLINKS, TILEDAREA, TIMEPICKER, TOGGLE, TOUCHFIELD, TOUCHFIELDNUMERIC, TOUCHSELECTOR, TOUCHSIGNATURE, TOUCHVIRTUALKEYBOARD, VIDEO, WINDOWSIZER, WORKPLACEPERSPECTIVESELECTOR

Attribute details

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).

The attribute value must be an expression.

#{tobedefined}Binding to IComponentAdapter instance

animatechangeofsize

If set to true then changes of the width/height of the component are animated.

trueWith animation
falseWithout animation (default)

blocked

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.

cutheight

In case the content of the component exceeds the available height and in case the height is defined as percentage value then the content by default will expand the height correspondingly. But, if defined as true, then the content will be cut.

trueCut content to fit into available height
falseExpand surrounding layout (default)

cutwidth

In case the content of the component exceeds the available width and in case the width is defined as percentage value then the content by default will expand the width correspondingly. But, if defined as true, then the content will be cut.

trueCut content to fit into available width
falseExpand surrounding layout (default)

height

Height of the control. Either defined as absolute value or as percentage value. Pay attention when using percentage sizing: the size refers to what is given from the components above. When using percentage sizing then you may use an extended syntax: "xxx%;<min>;<max>": in this case the minimum and maximum definitions are respected. If using absolute sizes you may append a "+" to define, that the size is extended if required by the component. - Please note: the sizing may be completely taken over by the parent component (e.g. if a component is used in a grid cell), in this case the size definintions on this component level are obsolete.

100100 pixels
120120 pixels
200200 pixels
50%50 percents
100%Full available height
100%;100Full available height, minimum 100 pixels
100%;100;500Full available height, minimum 100 pixels, maximum 500 pixels
100%;;500Full available height, maximum 500 pixels

reference

Reference to an outside object that is the content behind the component. E.g. a field is representing a certain field of a database table: in this case you could define the value table;column. The reference plays a siginficant role within the attributemacro management.

The attribute value must not be changed once the component is created.

refOne reference
ref1;ref2Two references
ref1;ref2;ref3Three references

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.

The attribute value must be an expression.

trueComponent is rendered (default)
falseComponent is not rendered

rounding

Rounding radius of edges of border/background. This is optical rounding - so has nothing to do with mathematical rounding... The definition is either made for all corners - or as semicolon separated variant for each corner.

0Straight edges
5Rounding with radius 5
10Rounding with radius 10
0;5;5;0indiviual per corner: left top, right top, right bottom, left bottom
0;50%;5;2indiviual per corner: any mixing is allowed..

shadingcolor

Color of the shading that is applied if the area is blocked. Please use a color with transparency so that the blocked content still shines trough.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

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.

width

Width of the control. Either defined as absolute value or as percentage value. Pay attention when using percentage sizing: the size refers to what is given from the components above. When using percentage sizing then you may use an extended syntax: "xxx%;<min>;<max>": in this case the minimum and maximum definitions are respected. - Please note: the sizing may be completely taken over by the parent component (e.g. if a component is used in a grid cell), in this case the size definintions on this component level are obsolete.

100100 Pixels
120120 Pixels
200200 Pixels
50%50 percents
100%Full available width
100%;100Full available width, minimum 100 pixels
100%;100;500Full available width, minimum 100 pixels, maximum 500 pixels
100%;;500Full available width, maximum 500 pixels

x

x-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!

y

y-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!