Package org.kuali.rice.krad.uif.widget

Class Growls

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
org.kuali.rice.krad.uif.component.ComponentBase
org.kuali.rice.krad.uif.widget.WidgetBase
org.kuali.rice.krad.uif.widget.Growls
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, LifecycleElement, Widget, org.springframework.core.Ordered
public class Growls extends WidgetBase
Growls sets up settings for growls global to the current view and its pages

Some basic options of the plugin are exposed through this class, however additional options can be passed through setComponentOptions as usual. However, the header and theme option is set by the growl processing in PageGroup automatically. See the jquery jGrowl plugin for more details.

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • Growls

      public Growls()

  • Method Details

    • getTemplateOptions

      public Map<String,String> getTemplateOptions()
      Override to add property values to the template options The options that are passed through to the Component renderer

      The Map key is the option name, with the Map value as the option value. See documentation on the particular widget render for available options.

      Specified by:
      getTemplateOptions in interface Component
      Overrides:
      getTemplateOptions in class ComponentBase
      Returns:
      Mapinvalid input: '<'String, String> options

    • isSticky

      public boolean isSticky()
      If true, the growl will stick to the page until the user dismisses it
      Returns:
      the sticky

    • setSticky

      public void setSticky(boolean sticky)
      Parameters:
      sticky - the sticky to set

    • getTimeShown

      public int getTimeShown()
      The time growls are shown in milliseconds
      Returns:
      the timeShown

    • setTimeShown

      public void setTimeShown(int timeShown)
      Parameters:
      timeShown - the timeShown to set

    • getPosition

      public String getPosition()
      The position for the growls to appear in the window There are five options available: top-left, top-right, bottom-left, bottom-right, center.
      Returns:
      the position

    • setPosition

      public void setPosition(String position)
      Parameters:
      position - the position to set