Class ScrollableHtml
Define a ScrollableHtml block to be displayed into a JBlocks.
- Defined in: jblocks.block.scrollablehtml.js
- Extends Icon
Constructor Attributes | Constructor Name and Description |
---|---|
A ScrollableHtml block displays arbitrary HTML and allow scrolling vertically in it. |
Method Summary
Class Detail
ScrollableHtml()
A ScrollableHtml block displays arbitrary HTML and allow scrolling vertically in it.
The constructor should not be invoked directly but JBlocks#newBlock or JBlocks#addNewBlock should be used instead.
Method Detail
-
checkState()Update scroller state.
-
{jQuerySet} getHtmlContainer()Returns the HTML container so content can be modified directly.
- Returns:
- the HTML container
-
init(layout, options)Initializes a ScrollableHtml block. The method is invoked by the jBlocks core and must never be called directly.
- Parameters:
- {Object} layout Optional
- see Block#init.
- {Object} options Optional
- in addition to base class options Block#init:
- {String} options.htmlContent Optional, Default: ""
- the initial HTML code to be inserted.
- {Boolean} options.verticalAlign Optional, Default: false
- align content vertically if possible.
- {Integer} options.scrollAnimation Optional, Default: 0
- the duration of the scroll animation in milliseconds.
-
makeVisible()Scroll to make specified height visible.
-
scrollBottom()Scroll to the bottom of the HTML content.
-
scrollTop()Scroll to the top of the HTML content.