com.sencha.gxt.widget.core.client.info

Class InfoConfig

java.lang.Object

com.sencha.gxt.widget.core.client.info.InfoConfig

Direct Known Subclasses:

DefaultInfoConfig, TemplateInfoConfig

public abstract class InfoConfig
extends Object

Abstract base class for configuration settings for Info.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InfoConfig.InfoPosition Defines the locations the Info is displayed.

Constructor Summary

Constructors

Constructor and Description
InfoConfig()

Method Summary

Modifier and Type	Method and Description
int	getDisplay() Returns the time the info is displayed.
int	getHeight() Returns the info height.
HideEvent.HideHandler	getHideHandler() Returns the hide handler.
int	getMargin() Returns the amount of pixels between info's.
InfoConfig.InfoPosition	getPosition() Returns the info position.
ShowEvent.ShowHandler	getShowHandler() Returns the show handler.
int	getWidth() Returns the info width.
protected abstract SafeHtml	render(Info info)
void	setDisplay(int display) Sets the amount of time the info is displayed in milliseconds (defaults to 2500).
void	setHeight(int height) Sets the info height (defaults to -1).
void	setHideHandler(HideEvent.HideHandler hideHandler) Sets the handler to be notified when the info is hidden.
void	setMargin(int margin) Sets the margin between info's (defaults to 10).
void	setPosition(InfoConfig.InfoPosition infoPosition) Sets the position the info is displayed (defaults to TOP_RIGHT).
void	setShowHandler(ShowEvent.ShowHandler showHandler) Sets the handler to be notified when the info is displayed.
void	setWidth(int width) Sets the width of the info (defaults to 225).

Methods inherited from class java.lang.Object

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

Constructor Detail

InfoConfig

public InfoConfig()

Method Detail

getDisplay

public int getDisplay()

Returns the time the info is displayed.

Returns:

the delay in milliseconds

getHeight

public int getHeight()

Returns the info height.

Returns:

the height

getHideHandler

public HideEvent.HideHandler getHideHandler()

Returns the hide handler.

Returns:

the hide handler

getMargin

public int getMargin()

Returns the amount of pixels between info's.

Returns:

the margin

getPosition

public InfoConfig.InfoPosition getPosition()

Returns the info position.

Returns:

the info position

getShowHandler

public ShowEvent.ShowHandler getShowHandler()

Returns the show handler.

Returns:

the show handler

getWidth

public int getWidth()

Returns the info width.

Returns:

the info width

setDisplay

public void setDisplay(int display)

Sets the amount of time the info is displayed in milliseconds (defaults to 2500).

Parameters:

display -

setHeight

public void setHeight(int height)

Sets the info height (defaults to -1).

Parameters:

height - the pixel height, -1 for auto height

setHideHandler

public void setHideHandler(HideEvent.HideHandler hideHandler)

Sets the handler to be notified when the info is hidden.

Parameters:

hideHandler - the hide handler

setMargin

public void setMargin(int margin)

Sets the margin between info's (defaults to 10).

Parameters:

margin - the margin

setPosition

public void setPosition(InfoConfig.InfoPosition infoPosition)

Sets the position the info is displayed (defaults to TOP_RIGHT).

Parameters:

infoPosition - the position

setShowHandler

public void setShowHandler(ShowEvent.ShowHandler showHandler)

Sets the handler to be notified when the info is displayed.

Parameters:

showHandler - the show handler

setWidth

public void setWidth(int width)

Sets the width of the info (defaults to 225).

Parameters:

width - the width in pixels

render

protected abstract SafeHtml render(Info info)