com.hybris.instore.widgets.listtracker

Class ListTrackerController

java.lang.Object

DefaultWidgetController

com.hybris.instore.widgets.listtracker.ListTrackerController

public class ListTrackerController
extends DefaultWidgetController

Keeps track of the active element in a list.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_ACTIVE_INDEX
static String	MODEL_LIST
static String	MODEL_NEXT_AVAILBLE
static String	MODEL_PREVIOUS_AVAILBLE
static String	SOCKET_IN_ACTIVE_INDEX
static String	SOCKET_IN_BACKWARD
static String	SOCKET_IN_FORWARD
static String	SOCKET_IN_LIST
static String	SOCKET_OUT_ACTIVE_OBJECT

Constructor Summary

Constructors

Constructor and Description
ListTrackerController()

Method Summary

Modifier and Type	Method and Description
void	activateNext() Activates the next element in the list.
void	activatePrevious() Activates the previous element in the list.
void	initialize(Component comp)
void	setActiveIndex(Integer activeIndex) Callback method for the activeIndex socket.
void	setList(List<? extends Object> list) Callback method for the list socket.
protected void	updateNavStatus(Integer activeIndex, List<Object> list) Updates the previous/next status i.e.

Methods inherited from class java.lang.Object

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

Field Detail

SOCKET_IN_BACKWARD

public static final String SOCKET_IN_BACKWARD

See Also:

Constant Field Values

SOCKET_IN_FORWARD

public static final String SOCKET_IN_FORWARD

See Also:

Constant Field Values

SOCKET_IN_LIST

public static final String SOCKET_IN_LIST

See Also:

Constant Field Values

SOCKET_IN_ACTIVE_INDEX

public static final String SOCKET_IN_ACTIVE_INDEX

See Also:

Constant Field Values

SOCKET_OUT_ACTIVE_OBJECT

public static final String SOCKET_OUT_ACTIVE_OBJECT

See Also:

Constant Field Values

MODEL_ACTIVE_INDEX

public static final String MODEL_ACTIVE_INDEX

See Also:

Constant Field Values

MODEL_LIST

public static final String MODEL_LIST

See Also:

Constant Field Values

MODEL_NEXT_AVAILBLE

public static final String MODEL_NEXT_AVAILBLE

See Also:

Constant Field Values

MODEL_PREVIOUS_AVAILBLE

public static final String MODEL_PREVIOUS_AVAILBLE

See Also:

Constant Field Values

Constructor Detail

ListTrackerController

public ListTrackerController()

Method Detail

initialize

public void initialize(Component comp)

setList

public void setList(List<? extends Object> list)

Callback method for the list socket. Sets the list, for which the active element should be tracked and resets the active "index" to zero.

Note: No "active" element will be dispatched when calling this method. Call setActiveIndex(Integer) to trigger a socket event.

Parameters:

list - the list to track

See Also:

setActiveIndex(Integer)

setActiveIndex

public void setActiveIndex(Integer activeIndex)

Callback method for the activeIndex socket. Marks the list's element with index activeIndex as the "active" element.

Note: If the specified index is not valid i.e. out of range, no socket event will be dispatched.

Parameters:

activeIndex - list index of active element

See Also:

setList(List)

activateNext

public void activateNext()

Activates the next element in the list. Basically calls setActiveIndex(Integer) with the argument currentIndex + 1.

Note: If no more elements are available the call is ignored.

See Also:

setActiveIndex(Integer), activatePrevious(), setList(List)

activatePrevious

public void activatePrevious()

Activates the previous element in the list. Basically calls setActiveIndex(Integer) with the argument currentIndex - 1.

Note: If no previous element is available the call is ignored.

See Also:

setActiveIndex(Integer), activateNext(), setList(List)

updateNavStatus

protected void updateNavStatus(Integer activeIndex,
                               List<Object> list)

Updates the previous/next status i.e. whether a previous and next element is available respectively.

Parameters:

activeIndex - the active element's index

list - the list