Composant JQuery UI Position property. More...
Inheritance diagram for Position:
Public Member Functions | |
| __construct ($my="left top", $at="left bottom", $collision="none", $within="window") | |
| setMy ($value) | |
| Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. | |
| setAt ($value) | |
| Defines which position on the target element to align the positioned element against: "horizontal vertical" alignment. | |
| setOf ($value) | |
| Which element to position against. | |
| setCollision ($value) | |
| When the positioned element overflows the window in some direction, move it to an alternative position. | |
| setWithin ($value) | |
| Element to position within, affecting collision detection. | |
| getScript () | |
| Public Member Functions inherited from BaseComponent | |
| __construct (JsUtils $js=NULL) | |
| setParam ($key, $value) | |
| getParam ($key) | |
| getParams () | |
| compile (JsUtils $js=NULL) | |
| setParams ($params) | |
| addParams ($params) | |
| setDebug ($value) | |
| setVerbose ($value) | |
Protected Member Functions | |
| setParamCtrl ($key, $value, $typeCtrl) | |
| Protected Member Functions inherited from BaseComponent | |
| getParamsAsJSON ($params) | |
Additional Inherited Members | |
| Data Fields inherited from BaseComponent | |
| $jquery_code_for_compile =array () | |
| Protected Attributes inherited from BaseComponent | |
| $params =array () | |
| $js | |
Detailed Description
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | $my = "left top", |
|
$at = "left bottom", |
|||
$collision = "none", |
|||
$within = "window" |
|||
| ) |
Definition at line 14 of file Position.php.
Member Function Documentation
◆ getScript()
| getScript | ( | ) |
Reimplemented from BaseComponent.
Definition at line 95 of file Position.php.
◆ setAt()
| setAt | ( | $value | ) |
Defines which position on the target element to align the positioned element against: "horizontal vertical" alignment.
See the my option for full details on possible values. Percentage offsets are relative to the target element
- Parameters
-
string $value default : left bottom
Definition at line 46 of file Position.php.
◆ setCollision()
| setCollision | ( | $value | ) |
When the positioned element overflows the window in some direction, move it to an alternative position.
Similar to my and at, this accepts a single value or a pair for horizontal/vertical, e.g., "flip", "fit", "fit flip", "fit none"
- Parameters
-
string $value default : none
Definition at line 69 of file Position.php.
◆ setMy()
| setMy | ( | $value | ) |
Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment.
A single value such as "right" will be normalized to "right center", "top" will be normalized to "center top" (following CSS convention). Acceptable horizontal values: "left", "center", "right". Acceptable vertical values: "top", "center", "bottom". Example: "left top" or "center center". Each dimension can also contain offsets, in pixels or percent, e.g., "right+10 top-25%". Percentage offsets are relative to the element being positioned.
- Parameters
-
string $value default : left top
Definition at line 34 of file Position.php.
◆ setOf()
| setOf | ( | $value | ) |
Which element to position against.
If you provide a selector or jQuery object, the first matching element will be used. If you provide an event object, the pageX and pageY properties will be used. Example: "#top-menu"
- Parameters
-
string $value default : null
Definition at line 58 of file Position.php.
◆ setParamCtrl()
|
protected |
Reimplemented from BaseComponent.
Definition at line 84 of file Position.php.
◆ setWithin()
| setWithin | ( | $value | ) |
Element to position within, affecting collision detection.
If you provide a selector or jQuery object, the first matching element will be used.
- Parameters
-
string $value default : window
Definition at line 80 of file Position.php.
The documentation for this class was generated from the following file:
- Ajax/ui/properties/Position.php