C# Class Fluqi.Widget.jMenu.PositionOptions

Models the Position child for setting placement of the menu control.
Show file Open project: toepoke/Fluqi

Public Methods

Method Description
Finish ( ) : jMenu.Options

Flags the end of the options configuration and returns the Fluent interface back to the Menu object.

PositionOptions ( Options options ) : System

Constructor

SetAt ( Core pos ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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 ) : PositionOptions

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.

Method Details

Finish() public method

Flags the end of the options configuration and returns the Fluent interface back to the Menu object.
public Finish ( ) : jMenu.Options
return jMenu.Options

PositionOptions() public method

Constructor
public PositionOptions ( Options options ) : System
options Options Menu options object
return System

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 ) : PositionOptions
pos Core
return PositionOptions

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 ) : PositionOptions
pos1 Core
pos2 Core
return PositionOptions

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 ) : PositionOptions
pos string
return PositionOptions

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 ) : PositionOptions
pos1 string
pos2 string
return PositionOptions

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 ) : PositionOptions
colli Fluqi.Core.Collision
return PositionOptions

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 ) : PositionOptions
colli1 Fluqi.Core.Collision
colli2 Fluqi.Core.Collision
return PositionOptions

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 ) : PositionOptions
colli string
return PositionOptions

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 ) : PositionOptions
colli1 string
colli2 string
return PositionOptions

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 ) : PositionOptions
pos Core
return PositionOptions

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 ) : PositionOptions
pos1 Core
pos2 Core
return PositionOptions

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 ) : PositionOptions
pos string
return PositionOptions

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 ) : PositionOptions
pos1 string
pos2 string
return PositionOptions

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 ) : PositionOptions
of string
return PositionOptions

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 ) : PositionOptions
usingFunc string
return PositionOptions