com.matthewtamlin.sliding_intro_screen_library

Interface SelectionIndicator

All Known Implementing Classes:

DotIndicator

public interface SelectionIndicator

A selection indicator is a visual representation of the selected item in a finite collection.

Method Summary

Modifier and Type	Method and Description
int	getNumberOfItems()
int	getSelectedItemIndex()
int	getTransitionDuration()
boolean	isVisible()
void	setNumberOfItems(int numberOfItems) Sets the number of items represented by this indicator and updates the UI to reflect the change.
void	setSelectedItem(int index, boolean animate) Sets the index of the currently selected item and updates the UI to reflect the change.
void	setTransitionDuration(int durationMs) Sets the duration to use when animating items between selected and unselected.
void	setVisibility(boolean show) Changes the visibility of this indicator.

Method Detail

setSelectedItem

void setSelectedItem(int index,
                     boolean animate)

Sets the index of the currently selected item and updates the UI to reflect the change.

Parameters:

index - the index of the selected item, counting from zero

animate - whether or not the UI change should be animated

getSelectedItemIndex

int getSelectedItemIndex()

Returns:

the index of the currently selected item, counting from zero

setNumberOfItems

void setNumberOfItems(int numberOfItems)

Sets the number of items represented by this indicator and updates the UI to reflect the change. This number should be equal to the size of the collection being represented.

Parameters:

numberOfItems - the number of items in the set this indicator represents, not negative

getNumberOfItems

int getNumberOfItems()

Returns:

the total number of items represented by this indicator

setTransitionDuration

void setTransitionDuration(int durationMs)

Sets the duration to use when animating items between selected and unselected.

Parameters:

durationMs - the duration to use, measured in milliseconds

getTransitionDuration

int getTransitionDuration()

Returns:

the duration to use when animating items between selected and unselected

setVisibility

void setVisibility(boolean show)

Changes the visibility of this indicator.

Parameters:

show - true to make this indicator visible, false otherwise

isVisible

boolean isVisible()

Returns:

true if this indicator is currently visible, false otherwise