Package com.mendix.webui

Class FeedbackHelper

java.lang.Object

com.mendix.webui.FeedbackHelper

public class FeedbackHelper
extends java.lang.Object

Provides helper methods for providing action feedback.

Constructor Summary

Constructors

Constructor	Description
FeedbackHelper()

Method Summary

Modifier and Type	Method	Description
static void	addCloseCallerFeedback(IContext context)	Add close caller feedback to context.
static void	addLoginFeedback(IContext context)	Add show login feedback to context.
static void	addLogoutFeedback(IContext context)	Add logout feedback to context.
static void	addOpenFormFeedback(IContext context, java.lang.String formName, IFeedback.FormTarget target)	Add open form feedback to context.
static void	addOpenFormFeedback(IContext context, java.lang.String formName, IFeedback.FormTarget target, boolean isResizable, int width, int height)	Add open form feedback to context.
static void	addOpenFormFeedback(IContext context, java.lang.String formName, IFeedback.FormTarget target, boolean isResizable, int width, int height, IMendixIdentifier currentIdentifier, java.util.List<IMendixIdentifier> constraints)	Add open form feedback to context.
static void	addOpenFormFeedback(IContext context, java.lang.String formName, IFeedback.FormTarget target, IMendixIdentifier currentIdentifier, java.util.List<IMendixIdentifier> constraints)	Add open form feedback to context.
static void	addOpenFormFeedback(IContext context, java.lang.String formName, java.lang.String title, IFeedback.FormTarget target)	Add open form feedback to context.
static void	addOpenFormFeedback(IContext context, java.lang.String formName, java.lang.String title, IFeedback.FormTarget target, boolean isResizable, int width, int height, IMendixIdentifier currentIdentifier, java.util.List<IMendixIdentifier> constraints)	Add open form feedback to context.
static void	addOpenFormFeedback(IContext context, java.lang.String formName, java.lang.String title, IFeedback.FormTarget target, IMendixIdentifier currentIdentifier, java.util.List<IMendixIdentifier> constraints)	Add open form feedback to context.
static void	addOpenFormFeedback(IContext context, java.lang.String formName, java.lang.String title, IFeedback.FormTarget target, java.lang.Boolean isResizable, int width, int height)	Add open form feedback to context.
static void	addRefreshClass(IContext context, java.lang.String objectClass)	Add refresh class object feedback to context.
static void	addRefreshObjectFeedback(IContext context, IMendixIdentifier id)	Add refresh object feedback to context.
static void	addRefreshObjectListFeedback(IContext context, java.util.List<IMendixIdentifier> ids)	Add refresh object list feedback to context.
static void	addTextMessageFeedback(IContext context, IFeedback.MessageType messageType, java.lang.String message, boolean blocking)	Add text message feedback to context.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedbackHelper

public FeedbackHelper()

Method Detail

addTextMessageFeedback

public static void addTextMessageFeedback(IContext context,
                                          IFeedback.MessageType messageType,
                                          java.lang.String message,
                                          boolean blocking)

Add text message feedback to context.

Parameters:

context - the context to add this feedback to

messageType - the message type

message - the message content

blocking - whether the message is blocking (user has to take action before message disappears)

addRefreshObjectFeedback

public static void addRefreshObjectFeedback(IContext context,
                                            IMendixIdentifier id)

Add refresh object feedback to context.

Parameters:

context - the context to add this feedback to

id - the id of the object to refresh

addRefreshObjectListFeedback

public static void addRefreshObjectListFeedback(IContext context,
                                                java.util.List<IMendixIdentifier> ids)

Add refresh object list feedback to context.

Parameters:

context - the context to add this feedback to

ids - the ids of the objects to refresh

addRefreshClass

public static void addRefreshClass(IContext context,
                                   java.lang.String objectClass)

Add refresh class object feedback to context.

Parameters:

context - the context to add this feedback to

objectClass - the name of the class to refresh

addOpenFormFeedback

public static void addOpenFormFeedback(IContext context,
                                       java.lang.String formName,
                                       IFeedback.FormTarget target)

Add open form feedback to context.

Parameters:

context - the context to add this feedback to

formName - path to the form to open

target - is target content, window (popup) or modal window

Throws:

MendixRuntimeException - if the form does not exist, or if the form expects multiple parameters.

addOpenFormFeedback

public static void addOpenFormFeedback(IContext context,
                                       java.lang.String formName,
                                       IFeedback.FormTarget target,
                                       IMendixIdentifier currentIdentifier,
                                       java.util.List<IMendixIdentifier> constraints)

Add open form feedback to context.

Parameters:

context - the context to add this feedback to

formName - path to the form to open

target - is target content, window (popup) or modal window

currentIdentifier - the currentIdentifier

constraints - the context objects

Throws:

MendixRuntimeException - if the form does not exist, or if the form expects multiple parameters.

addOpenFormFeedback

public static void addOpenFormFeedback(IContext context,
                                       java.lang.String formName,
                                       java.lang.String title,
                                       IFeedback.FormTarget target)

Add open form feedback to context.

Parameters:

context - the context to add this feedback to

formName - path to the form to open

title - the title of the form

target - is target content, window (popup) or modal window

Throws:

MendixRuntimeException - if the form does not exist, or if the form expects multiple parameters.

addOpenFormFeedback

public static void addOpenFormFeedback(IContext context,
                                       java.lang.String formName,
                                       java.lang.String title,
                                       IFeedback.FormTarget target,
                                       IMendixIdentifier currentIdentifier,
                                       java.util.List<IMendixIdentifier> constraints)

Add open form feedback to context.

Parameters:

context - the context to add this feedback to

formName - path to the form to open

title - the title of the form

target - is target content, window (popup) or modal window

currentIdentifier - the currentIdentifier

constraints - the context objects

Throws:

MendixRuntimeException - if the form does not exist, or if the form expects multiple parameters.

addOpenFormFeedback

public static void addOpenFormFeedback(IContext context,
                                       java.lang.String formName,
                                       java.lang.String title,
                                       IFeedback.FormTarget target,
                                       java.lang.Boolean isResizable,
                                       int width,
                                       int height)

Add open form feedback to context.

Parameters:

context - the context to add this feedback to

formName - path to the form to open

title - the title of the form

target - is target content, window (popup) or modal window

isResizable - whether the form is resizeable or not

width - the width of the form

height - the height of the form

Throws:

MendixRuntimeException - if the form does not exist, or if the form expects multiple parameters.

addOpenFormFeedback

public static void addOpenFormFeedback(IContext context,
                                       java.lang.String formName,
                                       IFeedback.FormTarget target,
                                       boolean isResizable,
                                       int width,
                                       int height)

Add open form feedback to context.

Parameters:

context - the context to add this feedback to

formName - path to the form to open

target - is target content, window (popup) or modal window

isResizable - whether the form is resizeable or not

width - the width of the form

height - the height of the form

Throws:

MendixRuntimeException - if the form does not exist, or if the form expects multiple parameters.

addOpenFormFeedback

public static void addOpenFormFeedback(IContext context,
                                       java.lang.String formName,
                                       IFeedback.FormTarget target,
                                       boolean isResizable,
                                       int width,
                                       int height,
                                       IMendixIdentifier currentIdentifier,
                                       java.util.List<IMendixIdentifier> constraints)

Add open form feedback to context.

Parameters:

context - the context to add this feedback to

formName - path to the form to open

target - is target content, window (popup) or modal window

isResizable - whether the form is resizeable or not

width - the width of the form

height - the height of the form

currentIdentifier - the currentIdentifier

constraints - the context objects

Throws:

MendixRuntimeException - if the form does not exist, or if the form expects multiple parameters.

addOpenFormFeedback

public static void addOpenFormFeedback(IContext context,
                                       java.lang.String formName,
                                       java.lang.String title,
                                       IFeedback.FormTarget target,
                                       boolean isResizable,
                                       int width,
                                       int height,
                                       IMendixIdentifier currentIdentifier,
                                       java.util.List<IMendixIdentifier> constraints)

Add open form feedback to context.

Parameters:

context - the context to add this feedback to

formName - path to the form to open

title - the title of the form

target - is target content, window (popup) or modal window

isResizable - whether the form is resizeable or not

width - the width of the form

height - the height of the form

currentIdentifier - the currentIdentifier

constraints - the context objects

Throws:

MendixRuntimeException - if the form does not exist, or if the form expects multiple parameters.

addLoginFeedback

public static void addLoginFeedback(IContext context)

Add show login feedback to context.

Parameters:

context - the context to add this feedback to

addLogoutFeedback

public static void addLogoutFeedback(IContext context)

Add logout feedback to context.

Parameters:

context - the context to add this feedback to

addCloseCallerFeedback

public static void addCloseCallerFeedback(IContext context)

Add close caller feedback to context.

Parameters:

context - the context to add this feedback to