org.apache.juneau.rest.widget

Class MenuItemWidget

java.lang.Object

org.apache.juneau.rest.widget.Widget

org.apache.juneau.rest.widget.MenuItemWidget

Direct Known Subclasses:

ContentTypeMenuItem, QueryMenuItem, StyleMenuItem

public abstract class MenuItemWidget
extends Widget

A subclass of widgets for rendering menu items with drop-down windows.

Defines some simple CSS and Javascript for enabling drop-down menus in the nav section of the page (although nothing keeps you from using it in an arbitrary location in the page).

The script specifies a "menuClick(element)" function that toggles the visibility of the next sibling of the element.

Subclasses should implement the following two methods:

• getLabel(RestRequest) - The menu item label.
• getContent(RestRequest) - The menu item content.

For example, to render a link that brings up a simple dialog in a div tag:

@Override public String getLabel() { return "my-menu-item"; }; @Override public Div getLabel() { return Html5Builder.div("Surprise!").style("color:red"); };

The HTML content returned by the getHtml(RestRequest) method is added where the "$W{...}" is referenced in the page.

See Also:

• Overview > juneau-rest-server > Widgets

Constructor Summary

Constructors

Constructor and Description
MenuItemWidget()

Method Summary

Modifier and Type	Method and Description
abstract Object	getContent(RestRequest req) The content of the popup.
String	getHtml(RestRequest req) Resolves the HTML content for this widget.
abstract String	getLabel(RestRequest req) The label for the menu item as it's rendered in the menu bar.
String	getScript(RestRequest req) Returns the Javascript needed for the show and hide actions of the menu item.
String	getStyle(RestRequest req) Defines a "menu-item" class that needs to be used on the outer element of the HTML returned by the getHtml(RestRequest) method.

Methods inherited from class org.apache.juneau.rest.widget.Widget

getClasspathResourceAsString, getClasspathResourceAsString, getName, loadHtml, loadScript, loadStyle

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuItemWidget

public MenuItemWidget()

Method Detail

getScript

public String getScript(RestRequest req)
                 throws Exception

Returns the Javascript needed for the show and hide actions of the menu item.

Overrides:

getScript in class Widget

Parameters:

req - The HTTP request object.

Returns:

The Javascript needed by this widget.

Throws:

Exception

getStyle

public String getStyle(RestRequest req)
                throws Exception

Defines a "menu-item" class that needs to be used on the outer element of the HTML returned by the getHtml(RestRequest) method.

Overrides:

getStyle in class Widget

Parameters:

req - The HTTP request object.

Returns:

The CSS styles needed by this widget.

Throws:

Exception

getHtml

public String getHtml(RestRequest req)
               throws Exception

Description copied from class: Widget

Resolves the HTML content for this widget.

A returned value of null will cause nothing to be added to the page.

Overrides:

getHtml in class Widget

Parameters:

req - The HTTP request object.

Returns:

The HTML content of this widget.

Throws:

Exception

getLabel

public abstract String getLabel(RestRequest req)
                         throws Exception

The label for the menu item as it's rendered in the menu bar.

Parameters:

req - The HTTP request object.

Returns:

The menu item label.

Throws:

Exception

getContent

public abstract Object getContent(RestRequest req)
                           throws Exception

The content of the popup.

Parameters:

req - The HTTP request object.

Returns:

The content of the popup.
Can be any of the following types:

• Reader - Serialized directly to the output.
• CharSequence - Serialized directly to the output.
• Other - Serialized as HTML using HtmlSerializer.DEFAULT.
  Note that this includes any of the org.apache.juneau.dto.html5 beans.

Throws:

Exception