Package com.neotropic.kuwaiba.modules.commercial.ospman.widgets

Class OutsidePlantView

  • public class OutsidePlantView
extends AbstractView<com.vaadin.flow.component.Component>
    Graphically displays Outside Plant elements on a map.
    Author:
    Johny Andres Ortega Ruiz <johny.ortega@kuwaiba.org>

    • Method Detail

      • nodeClickListener

        public void nodeClickListener​(ViewEventListener listener)
        Description copied from class: AbstractView
        Adds a listener to the node click events.
        Specified by:
        nodeClickListener in class AbstractView<com.vaadin.flow.component.Component>
        Parameters:
        listener - The listener object.

      • edgeClickListener

        public void edgeClickListener​(ViewEventListener listener)
        Description copied from class: AbstractView
        Adds a listener to the edge click events.
        Specified by:
        edgeClickListener in class AbstractView<com.vaadin.flow.component.Component>
        Parameters:
        listener - The listener object.

      • getAsXml

        public byte[] getAsXml()
        
 <view version="">
  <class>OSPView</class>
  <center lon="" lat=""></center>
  <zoom>0</zoom>
  <nodes>
   <node lon="" lat="" class="businessObjectClass">businessObjectId</node>
  </nodes>
  <edge>
   <edge id="" class="" asideid="" asideclass="" bsideid="" bsideclass="">
    <controlpoint lon="" lat=""></controlpoint>
   </edge>
  </edge>
 </view>
        Specified by:
        getAsXml in class AbstractView<com.vaadin.flow.component.Component>
        Returns:
        A byte array with an XML document representing the view. The format of the document must follow the Standard Kuwaiba View Text Format (SKTF)

      • getAsImage

        public byte[] getAsImage​(AbstractImageExporter exporter)
        Description copied from class: AbstractView
        Exports the view as image using the given exporter. It most likely will have to be called after calling #build() or #build(java.lang.Object).
        Specified by:
        getAsImage in class AbstractView<com.vaadin.flow.component.Component>
        Parameters:
        exporter - The exporter used to generate the byte array.
        Returns:
        A byte array with a formated byte array of the view.

      • newOspView

        public void newOspView()

      • getAsUiElement

        public com.vaadin.flow.component.Component getAsUiElement()
                                                   throws InvalidArgumentException
        Description copied from class: AbstractView
        Gets an embeddable visual component that can be rendered in a dashboard.It most likely will have to be called after calling #build() or #build(java.lang.Object).
        Specified by:
        getAsUiElement in class AbstractView<com.vaadin.flow.component.Component>
        Returns:
        An embeddable component (Panel, VerticalLayout, etc)
        Throws:
        InvalidArgumentException - If the component could not be created for some reason (most likely, misconfiguration).

      • buildFromSavedView

        public void buildFromSavedView​(byte[] view)
        
 <view version="">
  <class>OSPView</class>
  <center lon="" lat=""></center>
  <zoom>0</zoom>
  <nodes>
   <node lon="" lat="" class="businessObjectClass" overlayid="">businessObjectId</node>
  </nodes>
  <edge>
   <edge id="" class="" asideid="" asideclass="" bsideid="" bsideclass="" overlayid="">
    <controlpoint lon="" lat=""></controlpoint>
   </edge>
  </edge>
 </view>
        Specified by:
        buildFromSavedView in class AbstractView<com.vaadin.flow.component.Component>
        Parameters:
        view - The view to be rendered.

      • clean

        public void clean()
        Description copied from class: AbstractView
        Cleans the view so some other thing can be painted on the canvas. Typically this is used in refresh buttons.
        Specified by:
        clean in class AbstractView<com.vaadin.flow.component.Component>

      • addNode

        public AbstractViewNode addNode​(BusinessObjectLight businessObject,
                                Properties properties)
        Description copied from class: AbstractView
        Adds a node to views that are not generated automatically.
        Specified by:
        addNode in class AbstractView<com.vaadin.flow.component.Component>
        Parameters:
        businessObject - The business object behind the node to be added. Nodes that already exist will not be added.
        properties - The properties associated to this object, such as the location that will be used to place it or the URL of the icon that will represent the node.
        Returns:
        A reference to the newly added node.

      • addEdge

        public AbstractViewEdge addEdge​(BusinessObjectLight businessObject,
                                BusinessObjectLight sourceBusinessObject,
                                BusinessObjectLight targetBusinessObject,
                                Properties properties)
        Description copied from class: AbstractView
        Adds an edge to views that are not generated automatically.
        Specified by:
        addEdge in class AbstractView<com.vaadin.flow.component.Component>
        Parameters:
        businessObject - The business object behind the edge to be added. Edges that already exist will not be added.
        sourceBusinessObject - The business object behind the source node to the edge to be created.
        targetBusinessObject - The business object behind the target node to the edge to be created.
        properties - The properties associated to this object, such as the control points of the edge, or its color.
        Returns:
        A reference to the newly added edge.

      • removeNode

        public void removeNode​(BusinessObjectLight businessObject)
        Description copied from class: AbstractView
        remove a node from the viewMap
        Specified by:
        removeNode in class AbstractView<com.vaadin.flow.component.Component>
        Parameters:
        businessObject - The business object behind the node to be removed

      • removeEdge

        public void removeEdge​(BusinessObjectLight businessObject)
        Description copied from class: AbstractView
        remove a edge from the viewMap
        Specified by:
        removeEdge in class AbstractView<com.vaadin.flow.component.Component>
        Parameters:
        businessObject - The business object behind the edge to be removed