com.threerings.gwt.ui

Class Widgets

java.lang.Object

com.threerings.gwt.ui.Widgets

public class Widgets
extends Object

Convenience methods for creating and configuring widgets.

Constructor Summary

Constructors

Constructor and Description
Widgets()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getText(TextBoxBase box, String defaultAsBlank) Retrieve the text from the TextBox, unless it is the specified default, in which case we return "".
static TextBox	initTextBox(TextBox box, String text, int maxLength, int visibleLength) Configures a text box with all of the configuration that you're bound to want to do.
static <T extends Widget & HasClickHandlers> T	makeActionable(T target, ClickHandler onClick, Value<Boolean> enabled) Makes the supplied widget "actionable" which means adding the "actionLabel" style to it and binding the supplied click handler.
static Image	makeActionImage(Image image, String tip, ClickHandler onClick) Makes an image into one that responds to clicking.
static Label	makeActionLabel(Label label, ClickHandler onClick) Makes the supplied label into an action label.
static AbsolutePanel	newAbsolutePanel(String styleName) Creates a AbsolutePanel with the supplied style
static Image	newActionImage(String path, ClickHandler onClick) Creates an image that responds to clicking.
static Image	newActionImage(String path, String tip, ClickHandler onClick) Creates an image that responds to clicking.
static Label	newActionLabel(String text, ClickHandler onClick) Creates a label that triggers an action using the supplied text and handler.
static Label	newActionLabel(String text, String style, ClickHandler onClick) Creates a label that triggers an action using the supplied text and handler.
static FlowPanel	newFlowPanel(String styleName, Widget... contents) Creates a FlowPanel with the provided style and widgets.
static FlowPanel	newFlowPanel(Widget... contents) Creates a FlowPanel with the supplied widgets.
static HTML	newHTML(String text, String... styles) Creates a new HTML element with the specified contents and style.
static Image	newImage(AbstractImagePrototype image, String... styles) Creates an image with the supplied resource and style.
static Image	newImage(ImageResource image, String... styles) Creates an image with the supplied resource and style.
static Image	newImage(String path, String... styles) Creates an image with the supplied path and style.
static PushButton	newImageButton(String style, ClickHandler onClick) Creates an image button that changes appearance when you click and hover over it.
static Image	newInlineImage(String path) Creates an image that will render inline with text (rather than forcing a break).
static InlineLabel	newInlineLabel(String text, String... styles) Creates an inline label with optional styles.
static Label	newLabel(String text, String... styles) Creates a label with the supplied text and style and optional additional styles.
static PushButton	newPushButton(Image defaultImage, Image overImage, Image downImage, ClickHandler onClick) Creates a PushButton with default(up), mouseover and mousedown states.
static HorizontalPanel	newRow(HasVerticalAlignment.VerticalAlignmentConstant valign, String styleName, Widget... contents) Creates a row of widgets in a horizontal panel with a 5 pixel gap between them.
static HorizontalPanel	newRow(String styleName, Widget... contents) Creates a row of widgets in a horizontal panel with a 5 pixel gap between them.
static HorizontalPanel	newRow(Widget... contents) Creates a row of widgets in a horizontal panel with a 5 pixel gap between them.
static ScrollPanel	newScrollPanel(Widget contents, int xpad, int ypad) Wraps the supplied contents in a scroll panel that will set the max-width to Window.getClientWidth()-xpad and the max-height to Window.getClientHeight()-ypad.
static ScrollPanel	newScrollPanelX(Widget contents, int maxWidth) Wraps the supplied contents in a scroll panel with the specified maximum width.
static ScrollPanel	newScrollPanelY(Widget contents, int maxHeight) Wraps the supplied contents in a scroll panel with the specified maximum height.
static Widget	newShim(int width, int height) Makes a widget that takes up horizontal and or vertical space.
static SimplePanel	newSimplePanel(String styleName, Widget widget) Creates a SimplePanel with the supplied style and widget
static TextArea	newTextArea(String text, int width, int height) Creates a text area with all of the configuration that you're bound to want to do.
static LimitedTextArea	newTextArea(String text, int width, int height, int maxLength) Creates a limited text area with all of the configuration that you're bound to want to do.
static TextBox	newTextBox(String text, int maxLength, int visibleLength) Creates a text box with all of the configuration that you're bound to want to do.
static <B extends TextBoxBase> B	setPlaceholderText(B box, String placeholder) Set the placeholder text to use on the specified form field.
static <T extends Widget> T	setStyleNames(T widget, String... styles) Configures the supplied styles on the supplied widget.

Methods inherited from class java.lang.Object

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

Constructor Detail

Widgets

public Widgets()

Method Detail

newSimplePanel

public static SimplePanel newSimplePanel(String styleName,
                         Widget widget)

Creates a SimplePanel with the supplied style and widget

newFlowPanel

public static FlowPanel newFlowPanel(Widget... contents)

Creates a FlowPanel with the supplied widgets.

newFlowPanel

public static FlowPanel newFlowPanel(String styleName,
                     Widget... contents)

Creates a FlowPanel with the provided style and widgets.

newAbsolutePanel

public static AbsolutePanel newAbsolutePanel(String styleName)

Creates a AbsolutePanel with the supplied style

newScrollPanel

public static ScrollPanel newScrollPanel(Widget contents,
                         int xpad,
                         int ypad)

Wraps the supplied contents in a scroll panel that will set the max-width to Window.getClientWidth()-xpad and the max-height to Window.getClientHeight()-ypad. If either xpad or ypad are less than zero, the max-size attribute on that axis will not be set.

newScrollPanelX

public static ScrollPanel newScrollPanelX(Widget contents,
                          int maxWidth)

Wraps the supplied contents in a scroll panel with the specified maximum width.

newScrollPanelY

public static ScrollPanel newScrollPanelY(Widget contents,
                          int maxHeight)

Wraps the supplied contents in a scroll panel with the specified maximum height.

newRow

public static HorizontalPanel newRow(Widget... contents)

Creates a row of widgets in a horizontal panel with a 5 pixel gap between them.

newRow

public static HorizontalPanel newRow(String styleName,
                     Widget... contents)

Creates a row of widgets in a horizontal panel with a 5 pixel gap between them.

newRow

public static HorizontalPanel newRow(HasVerticalAlignment.VerticalAlignmentConstant valign,
                     String styleName,
                     Widget... contents)

Creates a row of widgets in a horizontal panel with a 5 pixel gap between them. The supplied style name is added to the container panel.

newLabel

public static Label newLabel(String text,
             String... styles)

Creates a label with the supplied text and style and optional additional styles.

newInlineLabel

public static InlineLabel newInlineLabel(String text,
                         String... styles)

Creates an inline label with optional styles.

newActionLabel

public static Label newActionLabel(String text,
                   ClickHandler onClick)

Creates a label that triggers an action using the supplied text and handler.

newActionLabel

public static Label newActionLabel(String text,
                   String style,
                   ClickHandler onClick)

Creates a label that triggers an action using the supplied text and handler. The label will be styled as specified with an additional style that configures the mouse pointer and adds underline to the text.

makeActionLabel

public static Label makeActionLabel(Label label,
                    ClickHandler onClick)

Makes the supplied label into an action label. The label will be styled such that it configures the mouse pointer and adds underline to the text.

makeActionable

public static <T extends Widget & HasClickHandlers> T makeActionable(T target,
                                                    ClickHandler onClick,
                                                    Value<Boolean> enabled)

Makes the supplied widget "actionable" which means adding the "actionLabel" style to it and binding the supplied click handler.

Parameters:

enabled - an optional value that governs the enabled state of the target. When the value becomes false, the target's click handler and "actionLabel" style will be removed, when it becomes true they will be reinstated.

newHTML

public static HTML newHTML(String text,
           String... styles)

Creates a new HTML element with the specified contents and style.

newImage

public static Image newImage(ImageResource image,
             String... styles)

Creates an image with the supplied resource and style.

newImage

public static Image newImage(AbstractImagePrototype image,
             String... styles)

Creates an image with the supplied resource and style.

newImage

public static Image newImage(String path,
             String... styles)

Creates an image with the supplied path and style.

newActionImage

public static Image newActionImage(String path,
                   ClickHandler onClick)

Creates an image that responds to clicking.

newActionImage

public static Image newActionImage(String path,
                   String tip,
                   ClickHandler onClick)

Creates an image that responds to clicking.

makeActionImage

public static Image makeActionImage(Image image,
                    String tip,
                    ClickHandler onClick)

Makes an image into one that responds to clicking.

newInlineImage

public static Image newInlineImage(String path)

Creates an image that will render inline with text (rather than forcing a break).

newTextBox

public static TextBox newTextBox(String text,
                 int maxLength,
                 int visibleLength)

Creates a text box with all of the configuration that you're bound to want to do.

setPlaceholderText

public static <B extends TextBoxBase> B setPlaceholderText(B box,
                                           String placeholder)

Set the placeholder text to use on the specified form field. This text will be shown when the field is blank and unfocused. Note: To safely read the text from this TextBox on all browsers, use getText(TextBoxBase, placeholder). This is because on legacy browsers that don't support HTML5 form awesomeness, the text will actually be set in the field when it is unfocused.

getText

public static String getText(TextBoxBase box,
             String defaultAsBlank)

Retrieve the text from the TextBox, unless it is the specified default, in which case we return "".

initTextBox

public static TextBox initTextBox(TextBox box,
                  String text,
                  int maxLength,
                  int visibleLength)

Configures a text box with all of the configuration that you're bound to want to do. This is useful for configuring a PasswordTextBox.

newTextArea

public static TextArea newTextArea(String text,
                   int width,
                   int height)

Creates a text area with all of the configuration that you're bound to want to do.

Parameters:

width - the width of the text area or -1 to use the default (or CSS styled) width.

newTextArea

public static LimitedTextArea newTextArea(String text,
                          int width,
                          int height,
                          int maxLength)

Creates a limited text area with all of the configuration that you're bound to want to do.

Parameters:

width - the width of the text area or -1 to use the default (or CSS styled) width.

newPushButton

public static PushButton newPushButton(Image defaultImage,
                       Image overImage,
                       Image downImage,
                       ClickHandler onClick)

Creates a PushButton with default(up), mouseover and mousedown states.

newImageButton

public static PushButton newImageButton(String style,
                        ClickHandler onClick)

Creates an image button that changes appearance when you click and hover over it.

newShim

public static Widget newShim(int width,
             int height)

Makes a widget that takes up horizontal and or vertical space. Shim shimminy shim shim shiree.

setStyleNames

public static <T extends Widget> T setStyleNames(T widget,
                                 String... styles)

Configures the supplied styles on the supplied widget. Existing styles will not be preserved unless you call this with no-non-null styles. Returns the widget for easy chaining.