Class DashletSpec


  • public class DashletSpec
    extends java.lang.Object
    This class defines the required configuration for instantiating a Dashlet.
    Author:
    Christian Pape, Marcus Hellberg (marcus@vaadin.com)
    • Constructor Summary

      Constructors 
      Constructor Description
      DashletSpec()
      Default constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DashletSpec clone()  
      int getBoostDuration()
      Returns the boost duration value.
      int getBoostPriority()
      Returns the boost priority value for this instance.
      java.lang.String getDashletName()
      This method returns the Dashlet name.
      int getDuration()
      Return the normal duration for transitions.
      java.util.Map<java.lang.String,​java.lang.String> getParameters()
      Returns the parameter Map.
      int getPriority()
      Returns the normal priority of this instance.
      java.lang.String getTitle()
      Returns the dashlet's title
      void setBoostDuration​(int boostDuration)
      Sets the boost duration value of this instance.
      void setBoostPriority​(int boostPriority)
      Sets the boost priority value.
      void setDashletName​(java.lang.String dashletName)
      This method sets the Dashlet name.
      void setDuration​(int duration)
      Sets the normal duration for transitions.
      void setParameters​(java.util.Map<java.lang.String,​java.lang.String> parameters)
      Sets the parameter Map.
      void setPriority​(int priority)
      Sets the priority for this instance.
      void setTitle​(java.lang.String title)
      Sets the title.
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DashletSpec

        public DashletSpec()
        Default constructor
    • Method Detail

      • getDuration

        public int getDuration()
        Return the normal duration for transitions.
        Returns:
        the duration
      • setDuration

        public void setDuration​(int duration)
        Sets the normal duration for transitions.
        Parameters:
        duration - the duration to set
      • getBoostDuration

        public int getBoostDuration()
        Returns the boost duration value.
        Returns:
        the boost duration
      • setBoostDuration

        public void setBoostDuration​(int boostDuration)
        Sets the boost duration value of this instance.
        Parameters:
        boostDuration - the boost duration to be set
      • getPriority

        public int getPriority()
        Returns the normal priority of this instance.
        Returns:
        the normal priority
      • setPriority

        public void setPriority​(int priority)
        Sets the priority for this instance.
        Parameters:
        priority - the priority to be set
      • getBoostPriority

        public int getBoostPriority()
        Returns the boost priority value for this instance.
        Returns:
        the boost priority value
      • setBoostPriority

        public void setBoostPriority​(int boostPriority)
        Sets the boost priority value.
        Parameters:
        boostPriority - the boost priority value to be set
      • setDashletName

        public void setDashletName​(java.lang.String dashletName)
        This method sets the Dashlet name.
        Parameters:
        dashletName - the name to be set
      • getDashletName

        public java.lang.String getDashletName()
        This method returns the Dashlet name.
        Returns:
        the Dashlet name
      • getParameters

        public java.util.Map<java.lang.String,​java.lang.String> getParameters()
        Returns the parameter Map.
        Returns:
        the parameters
      • setParameters

        public void setParameters​(java.util.Map<java.lang.String,​java.lang.String> parameters)
        Sets the parameter Map.
        Parameters:
        parameters - the parameters to be set
      • getTitle

        public java.lang.String getTitle()
        Returns the dashlet's title
      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title.
        Parameters:
        title - the title to be set
      • clone

        public DashletSpec clone()
        Overrides:
        clone in class java.lang.Object