ComposedControl
Extends:
Direct Subclass:
Indirect Subclass:
This is a class ComposedControl which provides some functionality for controls which are composed out of several other controls. It makes use of the composite pattern.
Constructor Summary
Public Constructor | ||
public |
constructor(options: ComposedControlOptions) |
Member Summary
Public Members | ||
public |
minHeight_: * |
|
public |
scrolled_: * |
|
public |
squeeze_: * |
Private Members | ||
private |
$container_: jQuery |
|
private |
|
|
private |
|
|
private |
|
|
private |
|
Method Summary
Public Methods | ||
public |
addControl(control: Control, options: Object) |
|
public |
used by positioning |
|
public |
|
|
public |
get$Container(): jQuery |
|
public |
getControls(): Control[] |
|
public |
isSqueezable(dimension: string): boolean Returns true if the control is squeezable in the given dimension. |
|
public |
Removes the squeeze. |
|
public |
removeControl(control: Control, propagate: boolean) |
|
public |
|
|
public |
Squeezes the control in the given dimension by the provided value. |
|
public |
|
Private Methods | ||
private |
addClasses_($item: jQuery): jQuery This method adds some helping css classes to the items |
Public Constructors
public constructor(options: ComposedControlOptions) source
Params:
Name | Type | Attribute | Description |
options | ComposedControlOptions |
|
Public Members
public minHeight_: * source
public scrolled_: * source
public squeeze_: * source
Private Members
private $container_: jQuery source
Public Methods
public addControl(control: Control, options: Object) source
Params:
Name | Type | Attribute | Description |
control | Control | ||
options | Object | ||
options.claim | Boolean |
|
if claim is set to false the control won't add anything to the container |
options.wrap | Boolean |
|
if wrap is set to true a span will be put arround the element if set to false the element of the control will be inserted directly |
options.cssPosition | Boolean |
|
if this is set to true the wrap or the element will get css classes indicating its position inside the container |
options.element | HTMLElement |
|
if this is set it will be put inside the container instead calling control.set$Target() |
public beforePositioning() source
public isSqueezable(dimension: string): boolean source
Returns true if the control is squeezable in the given dimension. Used by Positioning.
Params:
Name | Type | Attribute | Description |
dimension | string |
public release(dimension: string) source
Removes the squeeze. Used by Positioning.
Params:
Name | Type | Attribute | Description |
dimension | string |
public squeezeBy(dimension: string, value: number): number source
Squeezes the control in the given dimension by the provided value. Used by Positioning Returns the value the control could get squeezed by.
public updateVisibility() source
Private Methods
private addClasses_($item: jQuery): jQuery source
This method adds some helping css classes to the items
Params:
Name | Type | Attribute | Description |
$item | jQuery |
Return:
jQuery |