Package com.saperion.ngc.events

Class MaskInfoBean

java.lang.Object

com.saperion.ngc.events.MaskInfoBean

All Implemented Interfaces:

java.io.Serializable

public class MaskInfoBean
extends java.lang.Object
implements java.io.Serializable

This bean holds information about a form that is either about to be opened or that is already open.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MaskInfoBean(NavigationNode folderNode, FolderClass fClass, FolderFormType maskType)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addMaskOverride(FolderFormType type, java.lang.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.
java.lang.String	getDisplayName()
FolderClass	getFolderClass()
org.zkoss.zk.ui.event.EventListener	getFormCreatedListener()
java.lang.String	getMaskName()
java.lang.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.
FolderFormType	getMaskType()
NavigationNode	getNode()
java.lang.String	getQuery()
boolean	isAutoQuery()
void	setAutoQuery(boolean auto)	Sets the auto query parameter.
void	setDisplayName(java.lang.String value)
void	setFormCreatedListener(org.zkoss.zk.ui.event.EventListener formCreatedListener)	Sets the listener to be called when the form was created.
void	setQuery(java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaskInfoBean

public MaskInfoBean(NavigationNode folderNode,
                    FolderClass fClass,
                    FolderFormType maskType)

Constructor.

Parameters:

folderNode - Folder node

fClass - Folder class

maskType - Type of mask to open

Method Detail

getNode

public NavigationNode getNode()

Returns:

Folder node

getDisplayName

public java.lang.String getDisplayName()

Returns:

Display name

setDisplayName

public void setDisplayName(java.lang.String value)

Parameters:

value - New display name

getFolderClass

public FolderClass getFolderClass()

Returns:

Folder class

getMaskType

public FolderFormType getMaskType()

Returns:

Selected mask type

getMaskName

public java.lang.String getMaskName()

Returns:

actual mask name

getQuery

public final java.lang.String getQuery()

Returns:

Query, if exists

setQuery

public final void setQuery(java.lang.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,
                            java.lang.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 java.lang.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