com.github.gwtbootstrap.client.ui

Class Pagination

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.github.gwtbootstrap.client.ui.Pagination

All Implemented Interfaces:

HasId, HasStyle, IsResponsive, HasAttachHandlers, HasHandlers, EventListener, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, InsertPanel, InsertPanel.ForIsWidget, IsRenderable, IsWidget, Iterable<Widget>

public class Pagination
extends Composite
implements HasStyle, IsResponsive, HasId, InsertPanel.ForIsWidget, HasWidgets.ForIsWidget

Multi-Page Pagination

Since:

2.0.4.0

Author:

Dominik Mayer, Danilo Reinert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pagination.PaginationSize

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Pagination()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(IsWidget w)
void	add(Widget w)
NavLink	addNextLink() Insert a NavLink displaying ">" at the most right position of the Pagination widget
NavLink	addPageLink(int page) Insert a NavLink correctly allocated in the Pagination widget
NavLink	addPreviousLink() Insert a NavLink displaying "<" at the most left position of the Pagination widget
void	addStyle(Style style) Adds the provided style to the widget.
void	clear() Removes all child widgets.
String	getId() Get ID
Widget	getWidget(int index)
int	getWidgetCount()
int	getWidgetIndex(IsWidget child)
int	getWidgetIndex(Widget child)
void	insert(IsWidget w, int beforeIndex)
void	insert(Widget w, int beforeIndex) Inserts another widget into this one.
Iterator<Widget>	iterator() Gets an iterator for the contained widgets.
void	pullRight(boolean pullRight) Deprecated.
boolean	remove(int index)
boolean	remove(IsWidget w)
boolean	remove(Widget w) Removes a child widget.
void	removeStyle(Style style) Removes the provided style from the widget.
void	setAlignment(String alignment)
void	setHideOn(Device device) Sets the kind of device, this widget is hidden on.
void	setId(String id) Set ID
void	setPullRight(boolean pullRight) Pulls the widget to the right side.
void	setShowOn(Device device) Sets the kind of device, this widget is shown on.
void	setSize(Pagination.PaginationSize size)
void	setStyle(Style style) Replaces the widet's style with the provided one.

Methods inherited from class com.google.gwt.user.client.ui.Composite

getWidget, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, performDetachedInitialization, render, render, resolvePotentialElement, setWidget, wrapElement

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

Pagination

public Pagination()

Method Detail

setAlignment

public void setAlignment(String alignment)

setSize

public void setSize(Pagination.PaginationSize size)

add

public void add(IsWidget w)

Specified by:

add in interface HasWidgets.ForIsWidget

Specified by:

add in interface InsertPanel.ForIsWidget

remove

public boolean remove(IsWidget w)

Specified by:

remove in interface HasWidgets.ForIsWidget

insert

public void insert(IsWidget w,
          int beforeIndex)

Specified by:

insert in interface InsertPanel.ForIsWidget

getWidgetIndex

public int getWidgetIndex(IsWidget child)

Specified by:

getWidgetIndex in interface IndexedPanel.ForIsWidget

getWidget

public Widget getWidget(int index)

Specified by:

getWidget in interface IndexedPanel

getWidgetCount

public int getWidgetCount()

Specified by:

getWidgetCount in interface IndexedPanel

getWidgetIndex

public int getWidgetIndex(Widget child)

Specified by:

getWidgetIndex in interface IndexedPanel

remove

public boolean remove(int index)

Specified by:

remove in interface IndexedPanel

setId

public void setId(String id)

Set ID

Specified by:

setId in interface HasId

Parameters:

id - set id

getId

public String getId()

Get ID

Specified by:

getId in interface HasId

Returns:

ID

setHideOn

public void setHideOn(Device device)

Sets the kind of device, this widget is hidden on.

The widget is not hidden on any other device.

Only works if responsive design is turned on!

Specified by:

setHideOn in interface IsResponsive

See Also:

Configurator.hasResponsiveDesign(), IsResponsive.setShowOn(Device)

setShowOn

public void setShowOn(Device device)

Sets the kind of device, this widget is shown on.

The widget is not shown on any other device.

Only works if responsive design is turned on!

Specified by:

setShowOn in interface IsResponsive

See Also:

Configurator.hasResponsiveDesign(), IsResponsive.setHideOn(Device)

removeStyle

public void removeStyle(Style style)

Removes the provided style from the widget.

Specified by:

removeStyle in interface HasStyle

Parameters:

style - the style to be removed from the Widget.

addStyle

public void addStyle(Style style)

Adds the provided style to the widget.

Specified by:

addStyle in interface HasStyle

Parameters:

style - the style to be added to the Widget.

setStyle

public void setStyle(Style style)

Replaces the widet's style with the provided one.

Specified by:

setStyle in interface HasStyle

Parameters:

style - the style to be applied to the Widget.

pullRight

@Deprecated
public void pullRight(boolean pullRight)

Deprecated.

Use setPullRight instead.

Parameters:

pullRight - true if the widget should be aligned right.

setPullRight

public void setPullRight(boolean pullRight)

Pulls the widget to the right side.

Parameters:

pullRight - true if the widget should be aligned right.

add

public void add(Widget w)

Specified by:

add in interface HasWidgets

Specified by:

add in interface InsertPanel

clear

public void clear()

Removes all child widgets.

Specified by:

clear in interface HasWidgets

iterator

public Iterator<Widget> iterator()

Gets an iterator for the contained widgets. This iterator is required to implement Iterator.remove().

Specified by:

iterator in interface HasWidgets

Specified by:

iterator in interface Iterable<Widget>

remove

public boolean remove(Widget w)

Removes a child widget.

Specified by:

remove in interface HasWidgets

Parameters:

w - the widget to be removed

Returns:

true if the widget was present

insert

public void insert(Widget w,
          int beforeIndex)

Inserts another widget into this one.

Specified by:

insert in interface InsertPanel

Parameters:

w - the widget to be inserted

beforeIndex - the index of the position before which it should be set

addPageLink

public NavLink addPageLink(int page)

Insert a NavLink correctly allocated in the Pagination widget

Parameters:

page - the number of the page displayed by the NavLink

Returns:

the created NavLink filled with the page number

addPreviousLink

public NavLink addPreviousLink()

Insert a NavLink displaying "<" at the most left position of the Pagination widget

Returns:

the created NavLink

addNextLink

public NavLink addNextLink()

Insert a NavLink displaying ">" at the most right position of the Pagination widget

Returns:

the created NavLink