Package com.saperion.ngc.events

Class MaskInfoBean

java.lang.Object
com.saperion.ngc.events.MaskInfoBean
All Implemented Interfaces:
Serializable
public class MaskInfoBean extends Object implements Serializable
This bean holds information about a form that is either about to be opened or that is already open.
See Also:

  • Constructor Details

    • MaskInfoBean

      public MaskInfoBean(NavigationNode folderNode, FolderClass fClass, FolderFormType maskType)
      Constructor.
      Parameters:
      folderNode - Folder node
      fClass - Folder class
      maskType - Type of mask to open

  • Method Details

    • getNode

      public NavigationNode getNode()
      Returns:
      Folder node

    • getDisplayName

      public String getDisplayName()
      Returns:
      Display name

    • setDisplayName

      public void setDisplayName(String value)
      Parameters:
      value - New display name

    • getFolderClass

      public FolderClass getFolderClass()
      Returns:
      Folder class

    • getMaskType

      public FolderFormType getMaskType()
      Returns:
      Selected mask type

    • getMaskName

      public String getMaskName()
      Returns:
      actual mask name

    • getQuery

      public final String getQuery()
      Returns:
      Query, if exists

    • setQuery

      public final void setQuery(String value)
      Parameters:
      value - Query

    • isAutoQuery

      public boolean isAutoQuery()
      Returns:
      auto query

    • setAutoQuery

      public void setAutoQuery(boolean auto)
      Sets the auto query parameter.
      Parameters:
      auto - true to perform query

    • addMaskOverride

      public void addMaskOverride(FolderFormType type, String maskName)
      Adds a mask name that will be used to override the mask name set in the folder class for the specified form type.
      Parameters:
      type - form type
      maskName - mask name

    • getMaskOverride

      public String getMaskOverride(FolderFormType type)
      Returns a mask name set to override the mask name in the folder class for the specified form type or null if no override was set.
      Parameters:
      type - form type
      Returns:
      mask name

    • getFormCreatedListener

      public org.zkoss.zk.ui.event.EventListener getFormCreatedListener()
      Returns:
      the listener to be called when the form was created or null if not present

    • setFormCreatedListener

      public void setFormCreatedListener(org.zkoss.zk.ui.event.EventListener formCreatedListener)
      Sets the listener to be called when the form was created.
      Parameters:
      formCreatedListener - form-created listener