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

Class Disclosure

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.Disclosure
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, LifecycleElement, Widget, org.springframework.core.Ordered
public class Disclosure extends WidgetBase
Decorates a group with collapse/expand functionality
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • Disclosure

      public Disclosure()

  • Method Details

    • performApplyModel

      public void performApplyModel(Object model, LifecycleElement parent)
      Sets forceSessionPersistence when using the ajax retrieval option The following updates are done here:
      • Evaluate the progressive render condition (if set) and combine with the current render status to set the render status
      Called after the initialize phase to perform conditional logic based on the model data

      Where components can perform conditional logic such as dynamically generating new fields or setting field state based on the given data

      Specified by:
      performApplyModel in interface LifecycleElement
      Overrides:
      performApplyModel in class ComponentBase
      Parameters:
      model - - Top level object containing the data (could be the form or a top level business object, dto)
      parent - parent lifecycle element

    • getCollapsedIconClass

      public String getCollapsedIconClass()
      Class for the icon that should be rendered when the disclosure group is disclosed.

      Note this is only applicable when isRenderIcon() is true

      Returns:
      class for collapsed icon

    • setCollapsedIconClass

      public void setCollapsedIconClass(String collapsedIconClass)
      Setter for getCollapsedIconClass().
      Parameters:
      collapsedIconClass - property value

    • getExpandedIconClass

      public String getExpandedIconClass()
      Class for the icon that should be rendered when the disclosure group is expanded.

      Note this is only applicable when isRenderIcon() is true

      Returns:
      class for expanded icon

    • setExpandedIconClass

      public void setExpandedIconClass(String expandedIconClass)
      Setter for getExpandedIconClass().
      Parameters:
      expandedIconClass - property value

    • isRenderIcon

      public boolean isRenderIcon()
      Indicates whether the expanded and collapsed icons should be rendered for the disclosure.
      Returns:
      boolean true if icons should be rendered, false if not

    • setRenderIcon

      public void setRenderIcon(boolean renderIcon)
      Setter for isRenderIcon().
      Parameters:
      renderIcon - property value

    • getAnimationSpeed

      public int getAnimationSpeed()
      Gives the speed for the open/close animation, a smaller int will result in a faster animation
      Returns:
      animation speed

    • setAnimationSpeed

      public void setAnimationSpeed(int animationSpeed)
      Setter for the open/close animation speed
      Parameters:
      animationSpeed -

    • isDefaultOpen

      public boolean isDefaultOpen()
      Indicates whether the group should be initially open
      Returns:
      true if group should be initially open, false if it should be closed

    • setDefaultOpen

      public void setDefaultOpen(boolean defaultOpen)
      Setter for the default open indicator
      Parameters:
      defaultOpen -

    • isForceOpen

      public boolean isForceOpen()

    • setForceOpen

      public void setForceOpen(boolean forceOpen)

    • isAjaxRetrievalWhenOpened

      public boolean isAjaxRetrievalWhenOpened()
      When true, the group content will be retrieved when the disclosure is opened

      This only works if by default, the disclosure is closed.

      Returns:
      true if use ajax retrieval when disclosure opens, false otherwise

    • setAjaxRetrievalWhenOpened

      public void setAjaxRetrievalWhenOpened(boolean ajaxRetrievalWhenOpened)
      Set ajaxRetrievalWhenOpened
      Parameters:
      ajaxRetrievalWhenOpened -