documentation

Documentation generator: JsDoc Toolkit 2.4.0
Template: Wink 1.0
Generated on:

Namespace wink.ui.xy.layer

Implement a semi-transparent layer.
The layer is a literal so it doesn't need to be instantiated.
Use the 'show' and 'hide' method to display the layer or hide it.
The layer object is part of the core so you can either use 'wink.ui.xy.layer.show()' or directly 'wink.layer.show()'.
The layer object is part of the core so you can either use 'wink.ui.xy.layer.hide()' or directly 'wink.layer.hide()'.
You can see if the layer is displayed by checking its 'visible' attribute.
You can also define an 'onclick' method to the layer that will be called if the user clicks on the layer (see the test page for more details).

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Compatibility
Compatibility list Supported platforms / browsers
iOS2, iOS3, iOS4, iOS5, iOS6, Android 1.1, 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, Bada 1.0, Windows Phone 7.5, Windows Phone 8

Method Summary

Namespace Detail

wink.ui.xy.layer
wink.layer.show();

wink.layer.hide();
See:
Test page

Field Detail

<static> {string} wink.ui.xy.layer.color
The hexa code of the layer color
Default Value:
#000
<static> {number} wink.ui.xy.layer.opacity
Opacity level of the layer
Default Value:
0.3
<static> {boolean} wink.ui.xy.layer.visible
True if the layer is displayed, false otherwise
<static> {integer} wink.ui.xy.layer.zIndex
The hierarchical level of the layer
Default Value:
998

Method Detail

  • <static> wink.ui.xy.layer.hide()
    Hide the layer
  • <static> wink.ui.xy.layer.refresh()
    Update the display. Should be called in case of a change of height in the page for instance
  • <static> wink.ui.xy.layer.show()
    Display the layer
  • <static> wink.ui.xy.layer.update()
    Update the color, opacity and zIndex of the layer. Use this method if you want to change the opacity or color or zIndex after you called the 'show' method.