synergynet3.additionalitems.interfaces

Interface IScrollContainer

All Superinterfaces:

IItem, INestable

All Known Implementing Classes:

ScrollContainer

public interface IScrollContainer
extends IItem

The Interface IScrollContainer.

Nested Class Summary

Nested classes/interfaces inherited from interface multiplicity3.csys.items.INestable

INestable.IChildrenChangedListener

Method Summary

Methods

Modifier and Type	Method and Description
int	addFrame() Adds the frame.
void	addListenerToArrows(MultiTouchEventAdapter multiTouchEventAdapter) Adds the listener to arrows.
void	addToAllFrames(IItem userIcon, int x, int y) Adds the to all frames.
void	addToFrame(IItem audioRecorder, int frame, int x, int y) Adds the to frame.
IColourRectangle	getBackground() Gets the background.
IRoundedBorder	getBorder() Gets the border.
int	getCurrentFrame() Gets the current frame.
int	getHeight() Gets the height.
int	getWidth() Gets the width.
void	hideScrollButtons() Hide scroll buttons.
void	removeFrame(int toRemove) Removes the frame.
void	scrollToFrame(int frame) Scroll to frame.
void	setActive(boolean active) Sets the active.
void	setArrowHeightOverride(float newHeight) Sets the arrow height override.
void	setArrowWidthOverride(float width) Sets the arrow width override.
void	setArrowYOverride(float newY) Sets the arrow y override.
void	setDimensions(IStage stage, java.util.logging.Logger log, int width, int height) Sets the dimensions.
void	setFrameColour(com.jme3.math.ColorRGBA studentColour) Sets the frame colour.
void	setVisibility(java.lang.Boolean isVisible) Sets the visibility.
void	showCurrentFrameContents() Show current frame contents.

Methods inherited from interface multiplicity3.csys.items.item.IItem

addItemListener, behaviourAdded, centerItem, convertWorldVelocityToLocalVelocity, getBehaviours, getBehaviours, getItemListeners, getManipulableSpatial, getMultiTouchDispatcher, getName, getParentItem, getRelativeLocation, getRelativeLocationOfWorldLocation, getRelativeRotation, getRelativeScale, getUUID, getWorldLocation, getWorldLocation, getWorldRotationDegrees, getZOrder, getZOrderManager, isVisible, removeItemListener, setInteractionEnabled, setItemListeners, setParentItem, setRelativeLocation, setRelativeRotation, setRelativeScale, setVisible, setWorldLocation, setZOrder

Methods inherited from interface multiplicity3.csys.items.INestable

addItem, deRegisterChildrenChangedListener, getChildItems, getChildrenCount, hasChildren, registerChildrenChangedListener, removeAllItems, removeItem

Method Detail

addFrame

int addFrame()

Adds the frame.

Returns:

the int

addListenerToArrows

void addListenerToArrows(MultiTouchEventAdapter multiTouchEventAdapter)

Adds the listener to arrows.

Parameters:

multiTouchEventAdapter - the multi touch event adapter

addToAllFrames

void addToAllFrames(IItem userIcon,
                  int x,
                  int y)

Adds the to all frames.

Parameters:

userIcon - the user icon

x - the x

y - the y

addToFrame

void addToFrame(IItem audioRecorder,
              int frame,
              int x,
              int y)

Adds the to frame.

Parameters:

audioRecorder - the audio recorder

frame - the frame

x - the x

y - the y

getBackground

IColourRectangle getBackground()

Gets the background.

Returns:

the background

getBorder

IRoundedBorder getBorder()

Gets the border.

Returns:

the border

getCurrentFrame

int getCurrentFrame()

Gets the current frame.

Returns:

the current frame

getHeight

int getHeight()

Gets the height.

Returns:

the height

getWidth

int getWidth()

Gets the width.

Returns:

the width

hideScrollButtons

void hideScrollButtons()

Hide scroll buttons.

removeFrame

void removeFrame(int toRemove)

Removes the frame.

Parameters:

toRemove - the to remove

scrollToFrame

void scrollToFrame(int frame)

Scroll to frame.

Parameters:

frame - the frame

setActive

void setActive(boolean active)

Sets the active.

Parameters:

active - the new active

setArrowHeightOverride

void setArrowHeightOverride(float newHeight)

Sets the arrow height override.

Parameters:

newHeight - the new arrow height override

setArrowWidthOverride

void setArrowWidthOverride(float width)

Sets the arrow width override.

Parameters:

width - the new arrow width override

setArrowYOverride

void setArrowYOverride(float newY)

Sets the arrow y override.

Parameters:

newY - the new arrow y override

setDimensions

void setDimensions(IStage stage,
                 java.util.logging.Logger log,
                 int width,
                 int height)

Sets the dimensions.

Parameters:

stage - the stage

log - the log

width - the width

height - the height

setFrameColour

void setFrameColour(com.jme3.math.ColorRGBA studentColour)

Sets the frame colour.

Parameters:

studentColour - the new frame colour

setVisibility

void setVisibility(java.lang.Boolean isVisible)

Sets the visibility.

Parameters:

isVisible - the new visibility

showCurrentFrameContents

void showCurrentFrameContents()

Show current frame contents.