Class wink.ui.layout.FixedLayout
The Fixed layout implements a layout with "fixed" header and/or footer. There are two implementations depending on whether the fixed position is supported. If it is supported, then it is a native behavior that does not include public property.
- Defined in: fixedlayout.js
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
wink.ui.layout.FixedLayout(properties)
|
| Compatibility list | Supported platforms / browsers |
|---|---|
|
iOS2, iOS3, iOS4, iOS5, iOS6, Android 1.5, Android 2.1, Android 2.2, Android 2.3, Android 3.0, Android 3.1, Android 4.0, BlackBerry 6, BlackBerry 7, Windows Phone 8
|
Method Summary
Class Detail
wink.ui.layout.FixedLayout(properties)
var properties =
{
target: 'targetElementId',
header: 'headerElementId',
footer: 'footerElementId'
};
fixedlayout = new wink.ui.layout.FixedLayout(properties);
- Parameters:
- {object} properties
- The properties object
- {HTMLElement|string} properties.target
- The target node or its identifier
- {HTMLElement|string} properties.header Optional
- The header node or its identifier
- {HTMLElement|string} properties.footer Optional
- The footer node or its identifier
- {boolean} properties.hasHeaderFixed Optional, Default: true
- Indicates if the header node is fixed
- {boolean} properties.hasFooterFixed Optional, Default: true
- Indicates if the footer node is fixed
- {boolean} properties.nativeFixed Optional, Default: true
- False to enable the default implementation even if the fixed positioning is supported
- {integer} properties.displayDuration Optional, Default: 0
- The duration of the opacity transition when bars appear
- {integer} properties.moveDuration Optional, Default: 0
- The duration of the top transition when bars are partially visible (cut)
- {boolean} properties.preventTouchBar Optional, Default: true
- Prevents from moving the bars with touch
- {boolean} properties.activated Optional, Default: true
- Indicates if the layout is activated
- {boolean} properties.showHideOnClick Optional, Default: false
- Allows to show / hide the bars on click
- {integer} properties.urlBarShorcutHeight Optional, Default: 0
- Used when a shortcut is displayed for the url bar
- {boolean} properties.scrollAtStart Optional, Default: false
- Indicates if the component needs to listen the start event in order to hide bars properly
- {string} properties.paddingTop Optional, Default: header.offsetHeight
- Allows to explicitly define the paddingTop of the content
- {string} properties.paddingBottom Optional, Default: footer.offsetHeight
- Allows to explicitly define the paddingBottom of the content
- {boolean} properties.hideMode Optional, Default: true
- Allows to adapt the behavior of the bars to the expected mode
- Requires:
- wink.ux.window
- See:
- Test page
- Test page (opacity)
Field Detail
<static>
wink.ui.layout.FixedLayout.scrollTo
Scroll explicitly to the given position
Method Detail
-
<static> wink.ui.layout.FixedLayout.disable()Disables the bars position updates
-
<static> wink.ui.layout.FixedLayout.enable()Enables the bars position updates
-
<static> {integer} wink.ui.layout.FixedLayout.getPosition()
- Returns:
- {integer} the current y position
-
<static> wink.ui.layout.FixedLayout.refreshView()Refresh the view. This can be useful after a change of view.