org.opencms.ui.shared.components

Class CmsHistoryState

java.lang.Object

com.vaadin.shared.communication.SharedState

com.vaadin.shared.AbstractComponentState

org.opencms.ui.shared.components.CmsHistoryState

All Implemented Interfaces:

java.io.Serializable

public class CmsHistoryState
extends com.vaadin.shared.AbstractComponentState

The history state.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	HISTORY_BACK The history back flag.
static int	HISTORY_FORWARD The history forward flag.

Fields inherited from class com.vaadin.shared.AbstractComponentState

caption, captionAsHtml, description, descriptionContentMode, errorLevel, errorMessage, height, id, primaryStyleName, styles, width

Fields inherited from class com.vaadin.shared.communication.SharedState

enabled, registeredEventListeners, resources

Constructor Summary

Constructors

Constructor and Description
CmsHistoryState()

Method Summary

Modifier and Type	Method and Description
int	getHistoryDirection() Returns the history direction.
boolean	isHistoryBack() Returns if the history direction is back.
boolean	isHistoryForward() Returns if the history direction is forward.
void	setHistoryDirection(int direction) Sets the history direction.

Methods inherited from class java.lang.Object

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

Field Detail

HISTORY_BACK

public static final int HISTORY_BACK

The history back flag.

See Also:

Constant Field Values

HISTORY_FORWARD

public static final int HISTORY_FORWARD

The history forward flag.

See Also:

Constant Field Values

Constructor Detail

CmsHistoryState

public CmsHistoryState()

Method Detail

getHistoryDirection

public int getHistoryDirection()

Returns the history direction.

Returns:

the history direction

isHistoryBack

public boolean isHistoryBack()

Returns if the history direction is back.

Returns:

true if the history direction is back

isHistoryForward

public boolean isHistoryForward()

Returns if the history direction is forward.

Returns:

true if the history direction is forward

setHistoryDirection

public void setHistoryDirection(int direction)

Sets the history direction.

Use -1 for history back, and +1 for history forward.

Parameters:

direction - the history direction