Package org.neotropic.kuwaiba.modules.optional.physcon.widgets

Class ObjectViewWidget

java.lang.Object

org.neotropic.kuwaiba.core.apis.integration.modules.views.AbstractObjectRelatedViewWidget<com.vaadin.flow.component.orderedlayout.VerticalLayout>

org.neotropic.kuwaiba.modules.optional.physcon.widgets.ObjectViewWidget

@Component
public class ObjectViewWidget
extends AbstractObjectRelatedViewWidget<com.vaadin.flow.component.orderedlayout.VerticalLayout>

Toolkit for an ObjectView.

Author:

Orlando Paz <orlando.paz@kuwaiba.org>

Constructor Summary

Constructors

Constructor	Description
ObjectViewWidget()

Method Summary

Modifier and Type	Method	Description
String	appliesTo()	Indicates what inventory objects can be represented graphically using the toolkit.
com.vaadin.flow.component.orderedlayout.VerticalLayout	build(BusinessObjectLight businessObject)	The factory method that builds a view (a scene + container with tools).
String	getDescription()	More details on what the view does.
String	getName()	The name of the view.
String	getTitle()	The title of the view.
String	getVendor()	Who wrote the view.
String	getVersion()	The current version of the view.
void	saveView()
void	setButtonTitle(com.vaadin.flow.component.button.Button button, String title)	Set the title/tool tip for the given button

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectViewWidget

public ObjectViewWidget()

Method Detail

getName

public String getName()

Description copied from class: AbstractObjectRelatedViewWidget

The name of the view. This might not be important for hard-coded views, but it is relevant in custom, scripted views.

Specified by:

getName in class AbstractObjectRelatedViewWidget<com.vaadin.flow.component.orderedlayout.VerticalLayout>

Returns:

A short display name of the view

getDescription

public String getDescription()

Description copied from class: AbstractObjectRelatedViewWidget

More details on what the view does. This might not be important for hard-coded views, but it is relevant in custom, scripted views.

Specified by:

getDescription in class AbstractObjectRelatedViewWidget<com.vaadin.flow.component.orderedlayout.VerticalLayout>

Returns:

The view description.

getVersion

public String getVersion()

Description copied from class: AbstractObjectRelatedViewWidget

The current version of the view. This might not be important for hard-coded views, but it is relevant in custom, scripted views.

Specified by:

getVersion in class AbstractObjectRelatedViewWidget<com.vaadin.flow.component.orderedlayout.VerticalLayout>

Returns:

The version of the view.

getVendor

public String getVendor()

Description copied from class: AbstractObjectRelatedViewWidget

Who wrote the view.

Specified by:

getVendor in class AbstractObjectRelatedViewWidget<com.vaadin.flow.component.orderedlayout.VerticalLayout>

Returns:

A string with the name of the creator of the view, and preferably a way to contact it.

appliesTo

public String appliesTo()

Description copied from class: AbstractObjectRelatedViewWidget

Indicates what inventory objects can be represented graphically using the toolkit.

Specified by:

appliesTo in class AbstractObjectRelatedViewWidget<com.vaadin.flow.component.orderedlayout.VerticalLayout>

Returns:

The class of the instances.

getTitle

public String getTitle()

Description copied from class: AbstractObjectRelatedViewWidget

The title of the view.

Specified by:

getTitle in class AbstractObjectRelatedViewWidget<com.vaadin.flow.component.orderedlayout.VerticalLayout>

Returns:

A short display title of the view

build

public com.vaadin.flow.component.orderedlayout.VerticalLayout build(BusinessObjectLight businessObject)
                                                             throws InventoryException

Description copied from class: AbstractObjectRelatedViewWidget

The factory method that builds a view (a scene + container with tools).

Specified by:

build in class AbstractObjectRelatedViewWidget<com.vaadin.flow.component.orderedlayout.VerticalLayout>

Parameters:

businessObject - The object used as input to build the view.

Returns:

A visual component that can be embedded in dashboards and UIs.

Throws:

InventoryException - In case the process of building the view raises an exception while interacting with the persistence service.

setButtonTitle

public void setButtonTitle(com.vaadin.flow.component.button.Button button,
                           String title)

Set the title/tool tip for the given button

Parameters:

button - the button to be set

title - the title to be added

saveView

public void saveView()
              throws InventoryException

Throws:

InventoryException