org.netbeans.spi.dashboard

Class WidgetElement

java.lang.Object

org.netbeans.spi.dashboard.WidgetElement

Direct Known Subclasses:

WidgetElement.ActionElement, WidgetElement.ComponentElement, WidgetElement.ImageElement, WidgetElement.LinkElement, WidgetElement.SeparatorElement, WidgetElement.TextElement

public abstract class WidgetElement
extends Object

Elements that can be provided by a dashboard widget from DashboardWidget.elements(org.netbeans.spi.dashboard.DashboardDisplayer.Panel).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WidgetElement.ActionElement Action element.
static class	WidgetElement.ComponentElement Component element.
static class	WidgetElement.ImageElement Image element.
static class	WidgetElement.LinkElement Link element.
static class	WidgetElement.SeparatorElement Separator element.
static class	WidgetElement.TextElement Text element.

Method Summary

Modifier and Type	Method and Description
static WidgetElement.ActionElement	action(Action action) An action element.
static WidgetElement.ActionElement	actionLink(Action action) An action element.
static WidgetElement.ActionElement	actionLinkNoIcon(Action action) An action element.
static WidgetElement.ActionElement	actionNoIcon(Action action) An action element.
static WidgetElement.TextElement	aside(String text) An aside text element.
static WidgetElement.ComponentElement	component(java.util.function.Supplier<JComponent> componentSupplier) An element wrapping a Swing component supplier.
static WidgetElement.ImageElement	image(String resourcePath) An image element.
static WidgetElement.LinkElement	link(String text, URI link) A link to be opened in the default browser or viewer.
static WidgetElement.LinkElement	linkButton(String text, URI link) A link to be opened in the default browser or viewer.
static WidgetElement.SeparatorElement	separator() A separator element.
static WidgetElement.TextElement	subheading(String text) A sub-heading text element used to group other elements.
static WidgetElement.TextElement	text(String text) A normal text element.
static WidgetElement.TextElement	unavailable(String text) A text element providing a label for an unavailable resource (eg.

Methods inherited from class java.lang.Object

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

Method Detail

text

public static WidgetElement.TextElement text(String text)

A normal text element.

Parameters:

text - element text

Returns:

text element

aside

public static WidgetElement.TextElement aside(String text)

An aside text element. Text that is less important or provides additional information. May be rendered muted or smaller by the displayer.

Parameters:

text - element text

Returns:

text element

unavailable

public static WidgetElement.TextElement unavailable(String text)

A text element providing a label for an unavailable resource (eg. no recent files, network unavailable). May be rendered differently by the displayer.

Parameters:

text - element text

Returns:

text element

subheading

public static WidgetElement.TextElement subheading(String text)

A sub-heading text element used to group other elements. May be rendered larger by the displayer.

Parameters:

text - element text

Returns:

text element

image

public static WidgetElement.ImageElement image(String resourcePath)

An image element. The resource path should be one suitable for passing to ImageUtilities.loadImage(java.lang.String, boolean). The resource will be localized.

Parameters:

resourcePath - path to image

Returns:

image element

action

public static WidgetElement.ActionElement action(Action action)

An action element. The action will normally be rendered as a button by the displayer.

Parameters:

action - button action

Returns:

action element

actionNoIcon

public static WidgetElement.ActionElement actionNoIcon(Action action)

An action element. The action will normally be rendered as a button by the displayer. Hints that the displayer should not use any icon set on the action.

Parameters:

action - button action

Returns:

action element

actionLink

public static WidgetElement.ActionElement actionLink(Action action)

An action element. The action will normally be rendered as a hyperlink by the displayer.

Parameters:

action - link action

Returns:

action element

actionLinkNoIcon

public static WidgetElement.ActionElement actionLinkNoIcon(Action action)

An action element. The action will normally be rendered as a hyperlink by the displayer. Hints that the displayer should not use any icon set on the action.

Parameters:

action - link action

Returns:

action element

link

public static WidgetElement.LinkElement link(String text,
                                             URI link)

A link to be opened in the default browser or viewer. The link will normally be rendered as a hyperlink.

Parameters:

text - link text

link - link destination

Returns:

link element

linkButton

public static WidgetElement.LinkElement linkButton(String text,
                                                   URI link)

A link to be opened in the default browser or viewer. The link will normally be rendered as a button.

Parameters:

text - link text

link - link destination

Returns:

link element

separator

public static WidgetElement.SeparatorElement separator()

A separator element.

Returns:

separator element

component

public static WidgetElement.ComponentElement component(java.util.function.Supplier<JComponent> componentSupplier)

An element wrapping a Swing component supplier. This should only be used where the other elements cannot provide the required functionality. Some displayers may ignore component elements. The supplier must create a new component whenever requested.

Parameters:

componentSupplier - component supplier

Returns:

component element