C# Class Fluqi.Utilities.jPosition.Options

A set of properties to apply to a set of jQuery UI Position.
Properties not yet supported:
Inheritance: Core.Options
Mostrar archivo Open project: toepoke/Fluqi

Public Methods

Method Description
SetAt ( Core pos ) : Options

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
SetAt ( Core pos1, Core pos2 ) : Options

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
SetAt ( string pos ) : Options

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
SetAt ( string pos1, string pos2 ) : Options

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
SetCollision ( Fluqi.Core.Collision colli ) : Options

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, eg. "flip", "fit", "fit flip", "fit none". flip: to the opposite side and the collision detection is run again to see if it will fit. If it won't fit in either position, the center option should be used as a fall back. fit: so the element keeps in the desired direction, but is re-positioned so it fits. none: not do collision detection.

SetCollision ( Fluqi.Core.Collision colli1, Fluqi.Core.Collision colli2 ) : Options

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, eg. "flip", "fit", "fit flip", "fit none". flip: to the opposite side and the collision detection is run again to see if it will fit. If it won't fit in either position, the center option should be used as a fall back. fit: so the element keeps in the desired direction, but is re-positioned so it fits. none: not do collision detection.

SetCollision ( string colli ) : Options

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, eg. "flip", "fit", "fit flip", "fit none". flip: to the opposite side and the collision detection is run again to see if it will fit. If it won't fit in either position, the center option should be used as a fall back. fit: so the element keeps in the desired direction, but is re-positioned so it fits. none: not do collision detection.

SetCollision ( string colli1, string colli2 ) : Options

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, eg. "flip", "fit", "fit flip", "fit none". flip: to the opposite side and the collision detection is run again to see if it will fit. If it won't fit in either position, the center option should be used as a fall back. fit: so the element keeps in the desired direction, but is re-positioned so it fits. none: not do collision detection.

SetMy ( Core pos ) : Options

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
SetMy ( Core pos1, Core pos2 ) : Options

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
SetMy ( string pos ) : Options

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
SetMy ( string pos1, string pos2 ) : Options

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
SetOf ( string of ) : Options

Element to position against. If you provide a selector, the first matching element will be used. If you provide a jQuery object, the first element will be used. If you provide an event object, the pageX and pageY properties will be used. Example: "#top-menu"
SetUsingFunction ( string usingFunc ) : Options

When specified the actual property setting is delegated to this callback. Receives a single parameter which is a hash of top and left values for the position that should be set.
SetWithin ( string within ) : Options

Element to position within, affecting collision detection. If you provide a selector or jQuery object, the first matching element will be used.

Protected Methods

Method Description
EvalPositionSetting ( string s1, string s2 ) : string

Evaluates the incoming strings to ensure they are both populated with something sensible, and handles the fact they may not be (used by SetMy and SetAt which need this setting sensilbly otherwise nonsense gets assigned to the underlying properties.

Method Details

EvalPositionSetting() protected method

Evaluates the incoming strings to ensure they are both populated with something sensible, and handles the fact they may not be (used by SetMy and SetAt which need this setting sensilbly otherwise nonsense gets assigned to the underlying properties.
protected EvalPositionSetting ( string s1, string s2 ) : string
s1 string String1
s2 string String2
return string

SetAt() public method

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
public SetAt ( Core pos ) : Options
pos Core
return Options

SetAt() public method

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
public SetAt ( Core pos1, Core pos2 ) : Options
pos1 Core
pos2 Core
return Options

SetAt() public method

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
public SetAt ( string pos ) : Options
pos string
return Options

SetAt() public method

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
public SetAt ( string pos1, string pos2 ) : Options
pos1 string
pos2 string
return Options

SetCollision() public method

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, eg. "flip", "fit", "fit flip", "fit none". flip: to the opposite side and the collision detection is run again to see if it will fit. If it won't fit in either position, the center option should be used as a fall back. fit: so the element keeps in the desired direction, but is re-positioned so it fits. none: not do collision detection.
public SetCollision ( Fluqi.Core.Collision colli ) : Options
colli Fluqi.Core.Collision
return Options

SetCollision() public method

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, eg. "flip", "fit", "fit flip", "fit none". flip: to the opposite side and the collision detection is run again to see if it will fit. If it won't fit in either position, the center option should be used as a fall back. fit: so the element keeps in the desired direction, but is re-positioned so it fits. none: not do collision detection.
public SetCollision ( Fluqi.Core.Collision colli1, Fluqi.Core.Collision colli2 ) : Options
colli1 Fluqi.Core.Collision
colli2 Fluqi.Core.Collision
return Options

SetCollision() public method

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, eg. "flip", "fit", "fit flip", "fit none". flip: to the opposite side and the collision detection is run again to see if it will fit. If it won't fit in either position, the center option should be used as a fall back. fit: so the element keeps in the desired direction, but is re-positioned so it fits. none: not do collision detection.
public SetCollision ( string colli ) : Options
colli string
return Options

SetCollision() public method

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, eg. "flip", "fit", "fit flip", "fit none". flip: to the opposite side and the collision detection is run again to see if it will fit. If it won't fit in either position, the center option should be used as a fall back. fit: so the element keeps in the desired direction, but is re-positioned so it fits. none: not do collision detection.
public SetCollision ( string colli1, string colli2 ) : Options
colli1 string
colli2 string
return Options

SetMy() public method

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
public SetMy ( Core pos ) : Options
pos Core
return Options

SetMy() public method

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
public SetMy ( Core pos1, Core pos2 ) : Options
pos1 Core
pos2 Core
return Options

SetMy() public method

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
public SetMy ( string pos ) : Options
pos string
return Options

SetMy() public method

Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will default to "right center", "top" will default to "center top" (following CSS convention). Acceptable values: "top", "center", "bottom", "left", "right". Example: "left top" or "center center"
public SetMy ( string pos1, string pos2 ) : Options
pos1 string
pos2 string
return Options

SetOf() public method

Element to position against. If you provide a selector, the first matching element will be used. If you provide a jQuery object, the first element will be used. If you provide an event object, the pageX and pageY properties will be used. Example: "#top-menu"
public SetOf ( string of ) : Options
of string
return Options

SetUsingFunction() public method

When specified the actual property setting is delegated to this callback. Receives a single parameter which is a hash of top and left values for the position that should be set.
public SetUsingFunction ( string usingFunc ) : Options
usingFunc string
return Options

SetWithin() public method

Element to position within, affecting collision detection. If you provide a selector or jQuery object, the first matching element will be used.
public SetWithin ( string within ) : Options
within string
return Options