com.github.gwtbootstrap.client.ui

Class Scrollspy

java.lang.Object

com.github.gwtbootstrap.client.ui.Scrollspy

public class Scrollspy
extends Object

Navbar uses this class for the scrollspy.

Since:

2.0.4.0

Author:

Carlos Alexandro Becker

See Also:

Twitter Bootstrap ScrollSpy

Constructor Summary

Constructors

Constructor and Description
Scrollspy() Create Empty Scrollspy
Scrollspy(Navbar navbar)

Method Summary

Methods

Modifier and Type	Method and Description
void	configure() Configure the scrollspy in the configured navbar.
Navbar	getNavbar() Get navbar
Element	getSpyElement()
boolean	isConfigured()
void	refresh()
void	setNavbar(Navbar navbar) set navbar
void	setOffset(Integer offset) set data-offset.
void	setSpyElement(Element element) set spy target element.
void	setTarget(String target) set data-target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scrollspy

public Scrollspy(Navbar navbar)

Parameters:

navbar - The navbar that will be spied.

Scrollspy

public Scrollspy()

Create Empty Scrollspy

Method Detail

getNavbar

public Navbar getNavbar()

Get navbar

Returns:

nabvar.

setNavbar

public void setNavbar(Navbar navbar)

set navbar

Parameters:

navbar -

setTarget

public void setTarget(String target)

set data-target.

If set this,spyElement is set data-target attribute this target when configure() is called.

Parameters:

target - data-target value.like this,#some-id .some-classes

See Also:

Twitter Bootstrap ScrollSpy Options

setSpyElement

public void setSpyElement(Element element)

set spy target element.

If set this,Scrollspy set some setting to this argment when configure() is called.
If don't set this,Scrollspy set some setting to body tag.

Parameters:

element - spy target element.

See Also:

Twitter Bootstrap ScrollSpy Options

setOffset

public void setOffset(Integer offset)

set data-offset.

If set this,spyElement is set data-offset attribute this target when configure() is called.

Parameters:

target - data-offset value.

See Also:

Twitter Bootstrap ScrollSpy Options

configure

public void configure()

Configure the scrollspy in the configured navbar.

isConfigured

public boolean isConfigured()

getSpyElement

public Element getSpyElement()

refresh

public void refresh()