com.reveldigital.player.api

Interface RevelControl

All Known Implementing Classes:

CarouselView, ClockView, ComboView, FlashView, GadgetView, GalleryView, HotSpotView, MarqueeView, PagerView, QRCodeView, RichTextView, ShapeView, SlideshowView2, StaticImageView, TextView, TVView, WebView

public interface RevelControl

The Interface RevelControl.

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose.
int	getHeight() Gets the height.
int	getLeft() Gets the left position.
java.lang.String	getName() Gets the name.
java.util.Iterator<? extends Option>	getOptions() Gets the options.
Playlist	getPlaylist() Gets the playlist.
int	getTop() Gets the top position.
ModuleType	getType() Gets the module type.
int	getWidth() Gets the width.
int	getZIndex() Gets the z index.
void	initialize(Module module) Initialize.
boolean	isAutoStart() Checks if auto start is enabled.
boolean	isStarted() True is control is currently started.
void	setAutoStart(boolean flag) Sets auto start.
void	setLeft(int offset) Sets the left position.
void	setTop(int offset) Sets the top position.
void	start() Start.
void	stop() Stop.

Method Detail

getName

java.lang.String getName()

Gets the name.

Returns:

the name

getLeft

int getLeft()

Gets the left position.

Returns:

the left position

setLeft

void setLeft(int offset)

Sets the left position.

Parameters:

offset - the new left position

getTop

int getTop()

Gets the top position.

Returns:

the top position

setTop

void setTop(int offset)

Sets the top position.

Parameters:

offset - the new top position

getZIndex

int getZIndex()

Gets the z index.

Returns:

the z index

getWidth

int getWidth()

Gets the width.

Returns:

the width

getHeight

int getHeight()

Gets the height.

Returns:

the height

getType

ModuleType getType()

Gets the module type.

Returns:

the module type

getPlaylist

Playlist getPlaylist()

Gets the playlist.

Returns:

the playlist

getOptions

java.util.Iterator<? extends Option> getOptions()

Gets the options.

Returns:

the options

initialize

void initialize(Module module)

Initialize.

Parameters:

module - the module

start

void start()

Start.

stop

void stop()

Stop.

dispose

void dispose()

Dispose.

isAutoStart

boolean isAutoStart()

Checks if auto start is enabled. All controls default to true.

Returns:

true, if auto start is enabled

setAutoStart

void setAutoStart(boolean flag)

Sets auto start. If enabled play will begin immediately after template initialization.

Parameters:

flag - the new auto start value

isStarted

boolean isStarted()

True is control is currently started.

Returns:

true, if started