Knowledge Bridge Documentation

Help version: 3.3.8

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Reference > K4 BaseLibrary Designs > UIControlMixin

UIControlMixin Discussion

Description

UIControlMixin is a mixin containing rules that can be used by other designs.

We do not use it alone; instead, we use it to add the rules to other designs. Presently there are 22 UI designs that use this mixin (see below).

Parameter Rules

*height:

Height of the area relating to the design that the UIControlMixin is mixed into.

Example:

"full","auto","fill","200px","30%","50vh"

Choices:

*Possible values are "full", "auto" ,"fill" <number>px, <number>%, <number>vh.

*width:

Width of the area relating to the design that the UIControlMixin is mixed into.

Example:

"full","auto","fill","200px","30%","50vh","35vw"

Choices:

*Possible values are "full", "auto" ,"fill" <number>px, <number>%,<number>vw.

alignment:

Alignment position of the design that the UIControlMixin is mixed into.

Example:

“start”

Choices:

"start | end"

enabled:

This enables the design to function or not. If false is entered then the design will still be visible but will not function.

Example:

true

visibility:

This controls whether the design is visible or not.

Example:

return R.rootModel.Content =="Table Configurator"?'visible':'hidden'

Choices:

“visible | hidden”

container:

This points to the Container that the design belongs to.

Example:

this.nha.isKindOf("UIContainerMixin") ? this.nha : undefined

customSpec:

For entering custom specifications. ATTENTION GENE: CAN YOU ADD MORE TO THIS?

Example:

{}

sequenceNo:

This is the sorting number within the UIContainer or UIFieldset that defines where the design will appear.

Example:

*Both height and width may have these values:

full -

control will occupy whole available height or width respectively.

auto -

control will be sized automatically based on its content (container) or using pre-defined size.

fill -

control will fill in space in parent container that remains in row or column.

<number>px -

Number in pixels, example: "20px".

<number>vh -

viewport height percentage, example: "50vh".

<number>vw -

viewport width percentage, example: "35vw".

vw/vh relative to browser/iframe width/height

Mixins

UIStyleMixin

BaseNode

BaseModel

RULE NAME	TYPE	DEFAULTS	CATEGORY	FLAGS
height	string	"auto"	Geometry	Cached Parameter
width	string	"auto"	Geometry	Cached Parameter
alignment	string	""	Style	Cached Parameter
enabled	boolean	true	Style	Cached Parameter
visibility	string	"visible"	Style	Cached Parameter
container	any	this.nha.isKindOf("UIContainerMixin") ? this.nha : undefined	UI	Cached Parameter
customSpec	any	{}	UI	Cached Parameter
sequenceNo	number	0	UI	Cached Parameter