Package org.apache.juneau.rest.server.widget

Class QueryMenuItem

java.lang.Object

org.apache.juneau.rest.server.widget.Widget

org.apache.juneau.rest.server.widget.MenuItemWidget

org.apache.juneau.rest.server.widget.QueryMenuItem

All Implemented Interfaces:

HtmlWidget

public class QueryMenuItem
extends MenuItemWidget

Widget that returns a menu-item drop-down form for entering BeanQuery search/view/sort/paging arguments (search/view/sort/position/limit — see Queryable and BeanQueryRequest).

The variable it resolves is "$W{QueryMenuItem}".

Example:

@Rest(widgets=QueryMenuItem.class) @HtmlDocConfig(navlinks={"$W{QueryMenuItem}"}) public class MyResource extends BasicRestServlet {}

See Also:

• Queryable
• BeanQueryRequest
• Predefined Widgets
• Widgets

Constructor Summary

Constructors

Constructor	Description
QueryMenuItem()

Method Summary

Modifier and Type	Method	Description
String	getContent(RestRequest req, RestResponse res)	The content of the popup.
String	getLabel(RestRequest req, RestResponse res)	The label for the menu item as it's rendered in the menu bar.
String	getStyle(RestRequest req, RestResponse res)	Returns CSS for the tooltips.

Methods inherited from class org.apache.juneau.rest.server.widget.MenuItemWidget

getAfterShowScript, getBeforeShowScript, getHtml, getScript

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

getFileFinder, getHtml, getName, getScript, getStyle, loadHtml, loadHtmlWithVars, loadScript, loadScriptWithVars, loadStyle, loadStyleWithVars

Methods inherited from class java.lang.Object

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

Constructor Details

QueryMenuItem

public QueryMenuItem()

Method Details

getContent

public String getContent(RestRequest req,
 RestResponse res)

Description copied from class: MenuItemWidget

The content of the popup.

Specified by:

getContent in class MenuItemWidget

Parameters:

req - The HTTP request object.

res - The HTTP response 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.bean.html5 bean classes.

getLabel

public String getLabel(RestRequest req,
 RestResponse res)

Description copied from class: MenuItemWidget

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

Specified by:

getLabel in class MenuItemWidget

Parameters:

req - The HTTP request object.

res - The HTTP response object.

Returns:

The menu item label.

getStyle

public String getStyle(RestRequest req,
 RestResponse res)

Returns CSS for the tooltips.

Overrides:

getStyle in class MenuItemWidget

Parameters:

req - The HTTP request object.

res - The current HTTP response.

Returns:

The CSS styles needed by this widget.