net.malisis.core.client.gui.component.control

Interface IScrollable

All Known Implementing Classes:

BBCodeEditor, BBTextField, MCEditor, UIBackgroundContainer, UIContainer, UIInventory, UILabel, UIListContainer, UIPanel, UIPasswordField, UIPlayerInventory, UISelect.OptionsContainer, UITabGroup, UITextField, UIWindow

public interface IScrollable

This interface allows scrollbars to be added to the UIComponent implementer.

Method Summary

Modifier and Type	Method and Description
int	getBottomPadding() Gets the padding for the bottom.
int	getContentHeight() Gets the height of the scrollable content.
int	getContentWidth() Gets the width of the scrollable content.
int	getLeftPadding() Gets the padding for the left.
float	getOffsetX() Gets the offset from 0 to 1 of the scrollable content.
float	getOffsetY() Gets the offset from 0 to 1 of the scrollable content.
int	getRightPadding() Gets the padding for the right.
float	getScrollStep() Gets the amount of scrolling from 0 to 1, done by one step of the scroll wheel.
int	getTopPadding() Gets the padding for the top.
void	setOffsetX(float offsetX, int delta) Sets the offset from 0 to 1 of the scrollable content.
void	setOffsetY(float offsetY, int delta) Sets the offset from 0 to 1 of the scrollable content.

Method Detail

getContentWidth

int getContentWidth()

Gets the width of the scrollable content. It should count the total content size to be displayed when not clipped.

Returns:

the content width

getContentHeight

int getContentHeight()

Gets the height of the scrollable content. It should count the total content size to be displayed when not clipped.

Returns:

the content height

getOffsetX

float getOffsetX()

Gets the offset from 0 to 1 of the scrollable content. Only used for UIScrollBar.Type.HORIZONTAL scrollbars.

Returns:

the offset x

setOffsetX

void setOffsetX(float offsetX,
                int delta)

Sets the offset from 0 to 1 of the scrollable content. Only used for UIScrollBar.Type.HORIZONTAL scrollbars.
Delta is the size taken for the UIScrollBar.Type.VERTICAL scrollbar if available.

Parameters:

offsetX - the offset x

delta - the delta

getOffsetY

float getOffsetY()

Gets the offset from 0 to 1 of the scrollable content. Only used for UIScrollBar.Type.VERTICAL scrollbars.

Returns:

the offset x

setOffsetY

void setOffsetY(float offsetY,
                int delta)

Sets the offset from 0 to 1 of the scrollable content. Only used for UIScrollBar.Type.VERTICAL scrollbars.
Delta is the size taken for the UIScrollBar.Type.HORIZONTAL scrollbar if available.

Parameters:

offsetY - the offset y

delta - the delta

getScrollStep

float getScrollStep()

Gets the amount of scrolling from 0 to 1, done by one step of the scroll wheel.

Returns:

the scroll step

getTopPadding

int getTopPadding()

Gets the padding for the top.

Returns:

the top padding

getBottomPadding

int getBottomPadding()

Gets the padding for the bottom.

Returns:

the bottom padding

getLeftPadding

int getLeftPadding()

Gets the padding for the left.

Returns:

the left padding

getRightPadding

int getRightPadding()

Gets the padding for the right.

Returns:

the right padding