psdi.webclient.controls

Interface PortletState

All Known Implementing Classes:

PortletStateImpl

public interface PortletState

Interface for managing portlet state. Any portlet implemented in the Start Center frame work should implement these.

Author:

KD Singh

Field Summary

Fields

Modifier and Type	Field and Description
static long	LOADCALLED
static long	LOADED
static long	NOTLOADED

Method Summary

Methods

Modifier and Type	Method and Description
long	getLoadState() Returns load state
boolean	hasData() Returns true if has data
boolean	isFilterOpen() Returns whether portlet's filter is open
boolean	isFilterToggled()
boolean	isMaximised() Returns whether portlet is expanded
boolean	isPortletLoaded() Returns true if the portlet has been loaded && ignore reload is off
boolean	isPortletNotLoaded(ComponentInstance component) Returns true if portlet was never loaded
boolean	isPortletUpdated() Returns true of portlet was udpated
void	setFilterOpen(boolean newFlag) Sets filter open flag
void	setFilterToggled(boolean flag) Sets the filterToggled state
void	setHasData(boolean newFlag) Sets new has data flag
void	setLoadState(long status) /** Sets load state
void	setMaximised(boolean newFlag) Returns whether portlet is expanded
void	setPortletUpdated(boolean portletUpdated) Sets portlet updated state
void	setStateLoadCalled() Use to set load called state
void	setStateLoaded() Use to set loaded state
boolean	wasPortletLoadCalled() Returns true if portlet was just called for load

Field Detail

NOTLOADED

static final long NOTLOADED

See Also:

Constant Field Values

LOADCALLED

static final long LOADCALLED

See Also:

Constant Field Values

LOADED

static final long LOADED

See Also:

Constant Field Values

Method Detail

isPortletLoaded

boolean isPortletLoaded()

Returns true if the portlet has been loaded && ignore reload is off

wasPortletLoadCalled

boolean wasPortletLoadCalled()

Returns true if portlet was just called for load

isPortletNotLoaded

boolean isPortletNotLoaded(ComponentInstance component)

Returns true if portlet was never loaded

hasData

boolean hasData()

Returns true if has data

setHasData

void setHasData(boolean newFlag)

Sets new has data flag

getLoadState

long getLoadState()

Returns load state

setLoadState

void setLoadState(long status)

/** Sets load state

Parameters:

status -

isPortletUpdated

boolean isPortletUpdated()

Returns true of portlet was udpated

Returns:

setPortletUpdated

void setPortletUpdated(boolean portletUpdated)

Sets portlet updated state

Parameters:

portletUpdated -

isFilterToggled

boolean isFilterToggled()

Returns:

boolean - Returns the filterToggled.

setFilterToggled

void setFilterToggled(boolean flag)

Sets the filterToggled state

setMaximised

void setMaximised(boolean newFlag)

Returns whether portlet is expanded

isMaximised

boolean isMaximised()

Returns whether portlet is expanded

isFilterOpen

boolean isFilterOpen()

Returns whether portlet's filter is open

setFilterOpen

void setFilterOpen(boolean newFlag)

Sets filter open flag

setStateLoaded

void setStateLoaded()

Use to set loaded state

setStateLoadCalled

void setStateLoadCalled()

Use to set load called state