org.apache.juneau.rest.widget

Class QueryMenuItem

java.lang.Object

org.apache.juneau.rest.widget.Widget

org.apache.juneau.rest.widget.MenuItemWidget

org.apache.juneau.rest.widget.QueryMenuItem

public class QueryMenuItem
extends MenuItemWidget

Widget that returns a menu-item drop-down form for entering search/view/sort arguments.

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

This widget is designed to be used in conjunction with the Queryable converter, although implementations can process the query parameters themselves if they wish to do so by using the RequestQuery.getSearchArgs() method to retrieve the arguments and process the data themselves.

An example of this widget can be found in the PetStoreResource in the examples that provides search/view/sort capabilities against the collection of POJOs:

@RestMethod( name=GET, path="/", widgets={ QueryMenuItem.class, }, htmldoc=@HtmlDoc( navlinks={ "up: ...", "options: ...", "$W{QueryMenuItem}", "$W{ContentTypeMenuItem}", "$W{StyleMenuItem}", "source: ..." } ), converters=Queryable.class ) public Collection<Pet> getPets() {

It renders the following popup-box:

Tooltips are provided by hovering over the field names.

When submitted, the form submits a GET request against the current URI with special GET search API query parameters.
(e.g. "?s=column1=Foo*&v=column1,column2&o=column1,column2-&p=100&l=100").
The Queryable class knows how to perform these filters against collections of POJOs.

See Also:

• Overview > juneau-rest-server > Widgets

Constructor Summary

Constructors

Constructor and Description
QueryMenuItem()

Method Summary

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

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

getHtml, getScript

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

QueryMenuItem

public QueryMenuItem()

Method Detail

getStyle

public String getStyle(RestRequest req)
                throws Exception

Returns CSS for the tooltips.

Overrides:

getStyle in class MenuItemWidget

Parameters:

req - The HTTP request object.

Returns:

The CSS styles needed by this widget.

Throws:

Exception

getLabel

public String getLabel(RestRequest req)
                throws Exception

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.

Returns:

The menu item label.

Throws:

Exception

getContent

public String getContent(RestRequest req)
                  throws Exception

Description copied from class: MenuItemWidget

The content of the popup.

Specified by:

getContent in class MenuItemWidget

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