org.cruxframework.crux.widgets.client.dialog

Class Progress

java.lang.Object

org.cruxframework.crux.widgets.client.dialog.Progress

All Implemented Interfaces:

com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.IsWidget

public class Progress
extends Object
implements com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.IsWidget

Author:

Thiago da Rosa de Bustamante

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_STYLE_NAME

Constructor Summary

Constructors

Constructor and Description
Progress()

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.user.client.ui.Widget	asWidget()
String	getMessage() Gets the message to be displayed to the user
String	getTitle()
void	hide() Hides the progress dialog
boolean	isAnimationEnabled()
void	setAnimationEnabled(boolean animationEnabled)
void	setHeight(String height)
void	setMessage(com.google.gwt.safehtml.shared.SafeHtml message) Sets the message to be displayed to the user
void	setMessage(String message) Sets the message to be displayed to the user
void	setStyleName(String styleName)
void	setTitle(com.google.gwt.safehtml.shared.SafeHtml title)
void	setTitle(String title)
void	setWidth(String width)
void	show()
static Progress	show(String message) Shows a progress dialog
static Progress	show(String message, String styleName, boolean animationEnabled) Shows a progress dialog

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STYLE_NAME

public static final String DEFAULT_STYLE_NAME

See Also:

Constant Field Values

Constructor Detail

Progress

public Progress()

Method Detail

isAnimationEnabled

public boolean isAnimationEnabled()

Specified by:

isAnimationEnabled in interface com.google.gwt.user.client.ui.HasAnimation

See Also:

HasAnimation.isAnimationEnabled()

setAnimationEnabled

public void setAnimationEnabled(boolean animationEnabled)

Specified by:

setAnimationEnabled in interface com.google.gwt.user.client.ui.HasAnimation

See Also:

HasAnimation.setAnimationEnabled(boolean)

getMessage

public String getMessage()

Gets the message to be displayed to the user

Returns:

the message

setMessage

public void setMessage(com.google.gwt.safehtml.shared.SafeHtml message)

Sets the message to be displayed to the user

Parameters:

message -

setMessage

public void setMessage(String message)

Sets the message to be displayed to the user

Parameters:

message -

show

public void show()

hide

public void hide()

Hides the progress dialog

asWidget

public com.google.gwt.user.client.ui.Widget asWidget()

Specified by:

asWidget in interface com.google.gwt.user.client.ui.IsWidget

setStyleName

public void setStyleName(String styleName)

Parameters:

styleName -

setWidth

public void setWidth(String width)

Parameters:

width -

setHeight

public void setHeight(String height)

Parameters:

height -

setTitle

public void setTitle(com.google.gwt.safehtml.shared.SafeHtml title)

Parameters:

title -

setTitle

public void setTitle(String title)

Parameters:

title -

getTitle

public String getTitle()

Returns:

show

public static Progress show(String message)

Shows a progress dialog

Parameters:

message - the text to be displayed in the body of the message box

show

public static Progress show(String message,
            String styleName,
            boolean animationEnabled)

Shows a progress dialog

Parameters:

message - the text to be displayed in the body of the message box

styleName - the name of the CSS class to be applied in the message box element

animationEnabled - true to enable animations while showing or hiding the message box