Class AbstractDashletFactory

    • Field Detail

      • m_name

        protected java.lang.String m_name
        The name of the provided Dashlet
      • m_requiredParameters

        protected java.util.Map<java.lang.String,​java.lang.String> m_requiredParameters
        A map holding the required parameters for the Dashlet
      • m_requiredParameterDescriptions

        protected java.util.Map<java.lang.String,​java.lang.String> m_requiredParameterDescriptions
        A map holding the required parameter descriptions for the Dashlet
      • m_boostable

        protected boolean m_boostable
        boostable flag
      • m_dashboardSuitable

        protected boolean m_dashboardSuitable
        Are this dashlet suitable for displaying in the dashboard view.
    • Constructor Detail

      • AbstractDashletFactory

        public AbstractDashletFactory()
        Constructor for instantiating a new factory.
      • AbstractDashletFactory

        public AbstractDashletFactory​(java.lang.String name)
        Constructor for instantiating a new factory with the given name.
        Parameters:
        name - the dashlet's name
    • Method Detail

      • addRequiredParameter

        protected void addRequiredParameter​(java.lang.String key,
                                            java.lang.String defaultValue)
        Add a required parameter for this factory.
        Parameters:
        key - the key to use
        defaultValue - the default value for this parameter
      • getName

        public java.lang.String getName()
        Returns the name of the Dashlet instances this object provides.
        Specified by:
        getName in interface DashletFactory
        Returns:
        the name
      • setName

        public void setName​(java.lang.String name)
        Sets the name of the Dashlet instances this object provides.
        Parameters:
        name - the name
      • getRequiredParameters

        public java.util.Map<java.lang.String,​java.lang.String> getRequiredParameters()
        Returns the Map with the required parameters and default values.
        Specified by:
        getRequiredParameters in interface DashletFactory
        Returns:
        the Map holding the requires parameters
      • getRequiredParameterDescriptions

        public java.util.Map<java.lang.String,​java.lang.String> getRequiredParameterDescriptions()
        Returns the Map with the required parameter descriptions.
        Returns:
        the Map holding the requires parameter descriptions
      • setRequiredParameters

        public void setRequiredParameters​(java.util.Map<java.lang.String,​java.lang.String> requiredParameters)
        This method sets the required parameters Map.
        Parameters:
        requiredParameters - the parameter Map to be set
      • setRequiredParameterDescriptions

        public void setRequiredParameterDescriptions​(java.util.Map<java.lang.String,​java.lang.String> requiredParameterDescriptions)
        This method sets the required parameter descriptions Map.
        Parameters:
        requiredParameterDescriptions - the parameter description Map to be set
      • setBoostable

        public void setBoostable​(boolean boostable)
        This method sets the boostable flag.
      • setDashboardSuitable

        public void setDashboardSuitable​(boolean dashletSuitable)
        This method sets whether this dashlet is suitable for displaying in the dashboard view.
      • isSuitableForDashboard

        public boolean isSuitableForDashboard()
        Returns whether this dashlet is suitable for displaying in the dashboard view.
        Specified by:
        isSuitableForDashboard in interface DashletFactory
        Returns:
        true if suitable, false otherwise
      • isBoostable

        public boolean isBoostable()
        This method returns whether this dashlet is boostable.
        Specified by:
        isBoostable in interface DashletFactory
      • providesHelpComponent

        public boolean providesHelpComponent()
        Returns true, if the factory provides a help component for the Dashlet.
        Specified by:
        providesHelpComponent in interface DashletFactory
        Returns:
        true, if help component is provided, false otherwise
      • getHelpComponent

        public com.vaadin.ui.Component getHelpComponent()
        Returns the help component for the Dashlet.
        Specified by:
        getHelpComponent in interface DashletFactory
        Returns:
        the help component
      • getHelpContentHTML

        public abstract java.lang.String getHelpContentHTML()
        Returns the help content String
        Returns:
        the help content