public class

ViewPager

extends View

java.lang.Object
↳	com.neomades.ui.View
	↳	com.neomades.ui.ViewPager

Class Overview

A ViewPager control allows the user to flip left and right through pages of data.

Either you supply an implementation of a PagerAdapter (with setPagerAdapter()) to generate the pages that the view shows or you provide views with addView() for each pages.

Summary

[Expand]

Inherited XML Attributes

From class com.neomades.ui.View

[Expand]

Inherited Constants

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

Public Constructors
	ViewPager() Creates a new view pager.

Public Methods
void	addView(View view, int atIndex) Inserts a view (as a page) at a specified position.
void	addView(View view) Adds a new item view (as a page) to the ViewPager.
int	getCurrentPage() Returns the current selected tab.
int	getViewsCount() Returns the number of views (or pages) inside this container.
boolean	isEnabled() Returns a boolean indicating if the ViewPager is enabled or not.
void	notifyDataChanged() Notifies the pager that data has changed and the pager should update the UI
void	removeAllViews() Removes all views from this container.
void	removeIndex(int index) Removes a view from this list at the specified `index`.
void	removeView(View view) Removes a view from this list.
void	setCurrentPage(int number) Changes the current selected page.
void	setEnabled(boolean enabled) Enables or disables the ViewPager.
void	setOffScreenPageLimit(int pageLimit) Sets the number of pages that should be buffered to either side of the current page.
void	setPageChangeListener(PageChangeListener listener) Sets a page change listener to listen when the user changes the current page.
void	setPagerAdapter(PagerAdapter adapter) Set a PagerAdapter that will supply views for this pager as needed.
void	setPagerTitleStrip(PagerTitleStrip titleStrip) Sets a `PagerTitleStrip` to this ViewPager.

[Expand]

Inherited Methods

From class com.neomades.ui.View

View	findView(int viewId) Find view by Id.
int	getId() Returns the identifier of this element, by default all elements return "0".
Object	getTag() Returns this view's tag.
static View	inflateXML(int layoutResId) Inflate view from XMLLayout declared in the URS File.
static View	inflateXML(InputStream xmlStream) @return
boolean	isClickable() Returns if the view is clickable.
boolean	isEnabled() Return a boolean indicating if the view is enabled or not
boolean	isFocusable() Returns if the view is focusable (for the devices that have a keyboard Ui navigation).
boolean	isVisible() Returns if the view is visible
void	runOnUiThread(Runnable action) Calls `action.run()` asynchronously on the `UI-Thread`.
void	setBackground(Background background) Sets the background on this view.
void	setBackground(int backgroundResId) Sets the background on this view with a XML background definition.
void	setBackgroundColor(Color color) Sets the background color on this view.
void	setBackgroundImage(int imageID) Set the background image for this view.
void	setBackgroundImage(Image image) Set the background image for this view.
void	setBorderColor(Color borderColor) Sets the border color on this view.
void	setBorderWidth(int widthInDp) Set the border width (size) in DP units.
void	setClickListener(ClickListener clickListener) Sets a ClickListener to this view.
void	setClickable(boolean clickable) Sets this view clickable.
void	setCornerRadius(int radiusSize) Set the four corners radius, if the view has corners.
void	setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache.
void	setEnabled(boolean enabled) Sets the state of this view to enabled or disabled.
void	setFocusable(boolean focusable) Sets the view focusable.
void	setGestureDetector(GestureDetector detector) Sets a `GestureDetector` on this view.
void	setHeight(int heightDp) Sets the height of the view, in dp units (density-independent pixels).
void	setId(int id) Sets a identifier/tag to this element
void	setInvalidateDisabled(boolean disabled) If set to true, force the layout that contains the view to not be draw again when its content changes.
void	setLayoutAlignment(int alignment) Sets the view alignment into its parent.
void	setMargin(int uniformMarginDp) Set the margin outside this view (used by `Layout`), by setting on each side the given value.
void	setMargin(int leftDp, int topDp, int rightDp, int bottomDp) Set the margin outside this view (used by `Layout`).
void	setMarginBottom(int marginBottomDp) Sets the bottom margin with the given value.
void	setMarginLeft(int marginLeftDp) Sets the left margin with the given value.
void	setMarginRight(int marginRightDp) Sets the right margin with the given value.
void	setMarginTop(int marginTopDp) Sets the top margin with the given value.
void	setPadding(int leftDp, int topDp, int rightDp, int bottomDp) Sets the view padding.
void	setPadding(int uniformPaddingDp) Sets the view padding, with for each side the value given in parameter.
void	setPaddingBottom(int paddingBottomDp) Sets the bottom padding with the given value.
void	setPaddingLeft(int paddingLeftDp) Sets the left padding with the given value.
void	setPaddingRight(int paddingRightDp) Sets the right padding with the given value.
void	setPaddingTop(int paddingTopDp) Sets the top padding with the given value.
void	setSize(int widthDp, int heightDp) Sets the size of the view, in dp units (density-independent pixels).
void	setStretchHorizontalMode(int widthMode) Sets the stretch horizontal mode.
void	setStretchMode(int horizontalMode, int verticalMode) Sets the view content stretch mode.
void	setStretchVerticalMode(int heightMode) Sets the stretch vertical mode.
void	setStyle(int styleResId)
void	setStyle(Style style)
void	setTag(Object tag) Sets the tag associated with this view.
void	setTouchListener(TouchListener touchListener) Register a listener to be invoked when a touch event is dispatched to this view.
void	setTransformOrigin(float xOrigin, float yOrigin) Sets the x and y location of the point around which the view will be scaled or rotated when an animation occurs.
void	setVisible(boolean visible) Sets the view's visibility : visible or invisible/hidden
void	setWidth(int widthDp) Sets the width of the view, in dp units (density-independent pixels).

From class java.lang.Object

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
final Class<?>	getClass() Returns the runtime class of an object.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
final void	wait() Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public Constructors

public ViewPager ()

Creates a new view pager.

Public Methods

public void addView (View view, int atIndex)

Inserts a view (as a page) at a specified position.

Parameters

view	the view to insert
atIndex	the position index

Throws

CrossThreadException

public void addView (View view)

Adds a new item view (as a page) to the ViewPager.

Parameters

view	child to add

Throws

CrossThreadException	if the method is called from outside the UI-Thread
IllegalStateException	if the view child has already a parent

public int getCurrentPage ()

Returns the current selected tab.

Returns

the integer value of the selected tab

public int getViewsCount ()

Returns the number of views (or pages) inside this container.

Returns

the number of views

public boolean isEnabled ()

Returns a boolean indicating if the ViewPager is enabled or not. When the pager is disabled, it cannot be scrolled.

Returns

true if the ViewPager is enabled, false if it is disabled

public void notifyDataChanged ()

Notifies the pager that data has changed and the pager should update the UI

public void removeAllViews ()

Removes all views from this container.

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void removeIndex (int index)

Removes a view from this list at the specified index.

Throws

CrossThreadException

public void removeView (View view)

Removes a view from this list. if the view is not a child of this ListView, an IllegalStateException is thrown.

Parameters

view	the view to remove

Throws

CrossThreadException	if the method is called from outside the UI-Thread
IllegalStateException	if the view is not a child of this list
NullPointerException	if the view is null

public void setCurrentPage (int number)

Changes the current selected page. If the index of the page is outside the pager bounds, nothing is done.

Parameters

number	current tab index

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setEnabled (boolean enabled)

Enables or disables the ViewPager. When the pager is disabled, it cannot be scrolled.

Parameters

enabled	the new state of the ViewPager: `true` for enabled, `false` for disabled

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setOffScreenPageLimit (int pageLimit)

Sets the number of pages that should be buffered to either side of the current page. Pages beyond this limit will be recreated from the adapter when needed.

By default, the limit is set to 1. This is offered as an optimization. If you know in advance the number of pages you will need to support or have lazy-loading mechanisms in place on your pages, tweaking this setting can have benefits in perceived smoothness of paging animations and interaction. If you have a small number of pages (3-4) that you can keep active all at once, less time will be spent in layout for newly created view subtrees as the user pages back and forth. You should keep this limit low, especially if your pages have complex layouts.

Parameters

pageLimit	the number of pages that should be buffered to either side of the current page

public void setPageChangeListener (PageChangeListener listener)

Sets a page change listener to listen when the user changes the current page.

Parameters

listener	a listener or null

public void setPagerAdapter (PagerAdapter adapter)

Set a PagerAdapter that will supply views for this pager as needed.

Parameters

adapter	Adapter to use

public void setPagerTitleStrip (PagerTitleStrip titleStrip)

Sets a PagerTitleStrip to this ViewPager. This will enable to display titles for each pages of the pager. Titles will be displayed above the pager and will move with their associated page.

Parameters

titleStrip	the PagerTitleStrip that will contain the titles of the pager pages

Interfaces

Classes

Enums

Exceptions

ViewPager

Class Overview

Summary

Public Constructors

public ViewPager ()

Public Methods

public void addView (View view, int atIndex)

Parameters

Throws

public void addView (View view)

Parameters

Throws

public int getCurrentPage ()

Returns

public int getViewsCount ()

Returns

public boolean isEnabled ()

Returns

See Also

public void notifyDataChanged ()

public void removeAllViews ()

Throws

public void removeIndex (int index)

Throws

public void removeView (View view)

Parameters

Throws

public void setCurrentPage (int number)

Parameters

Throws

public void setEnabled (boolean enabled)

Parameters

Throws

See Also

public void setOffScreenPageLimit (int pageLimit)

Parameters

public void setPageChangeListener (PageChangeListener listener)

Parameters

public void setPagerAdapter (PagerAdapter adapter)

Parameters

See Also

public void setPagerTitleStrip (PagerTitleStrip titleStrip)

Parameters

See Also