jb.gwt_main_modules.base_widgets.client.js_api.mf

Class M3TAFormApiPublisher

java.lang.Object

jb.gwt_main_modules.base_widgets.client.js_api.mf.M3TAFormApiPublisher

public class M3TAFormApiPublisher
extends java.lang.Object

Publishes API for working with M3TAForms.

All methods are located in a sub object at window.MBAPI.mf

(window.MBAPI.mf.displayM3TAForm(theCallback, theForms, theOpenCallback, theHidePositive, theHideNegative, thePositiveText, theNegativeText, theHeaderText) for example)

Constructor Summary

Constructors

Constructor and Description
M3TAFormApiPublisher()

Method Summary

Modifier and Type	Method and Description
private static void	addM3TAForm(NativeM3TAForm theM3TAForm) Intended for internal use.
private static void	createM3TAForm(DefaultCallback theSaveCallback, com.google.gwt.dom.client.Element theElement, java.lang.String theForms, int theWidth, int theHeight, com.google.gwt.core.client.JavaScriptObject theOpenCallback) Creates a M3TAForm panel to be placed in the passed in element
private static void	displayM3TAForm(DefaultCallback theCallback, java.lang.String theForms, com.google.gwt.core.client.JavaScriptObject theOpenCallback, boolean theHidePositive, boolean theHideNegative, java.lang.String thePositiveText, java.lang.String theNegativeText, java.lang.String theHeaderText) Display a dialog with m3taforms in it for collection data for a js function
private static void	getDictionarySuggestions(int theDictionaryId, java.lang.String theQuery, int theOffset, int thePageSize, <any> theCallback) Get a list of suggestions from a dictionary
private static void	getInternalDictionarySuggestion(int theDictionaryId, java.lang.String theQuery, int theOffset, int thePageSize, com.google.gwt.core.client.JavaScriptObject theCallback)
private static com.google.gwt.core.client.JsArray	getJSArray() Intended for internal use.
private static void	getM3TAForm(java.lang.String theM3TAFormInstanceId) Intended for internal use.
private static void	removeM3TAForm(java.lang.String theM3TAFormInstanceId) Intended for internal use.
private static void	setupAPI() Initialize the message API namespace object.
static void	setupJavascriptAPIs() Setup the M3TAForm javascript API.
private static void	showAssetM3TAFormDialog(int theAssetId, java.lang.String theForm, java.lang.String theHeaderText, java.lang.String theSaveButtonText) Display a dialog with a metaform in it, correlated to a single asset
private static com.google.gwt.core.client.JavaScriptObject	transformWordSuggestion(WordSuggestion theWord) Intended for internal use.
private static com.google.gwt.core.client.JsArray	transformWordSuggestions(java.util.List<WordSuggestion> theArray)

Methods inherited from class java.lang.Object

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

Constructor Detail

M3TAFormApiPublisher

public M3TAFormApiPublisher()

Method Detail

setupJavascriptAPIs

public static void setupJavascriptAPIs()

Setup the M3TAForm javascript API.

setupAPI

private static void setupAPI()

Initialize the message API namespace object. Keeps array of open M3TAForms

getInternalDictionarySuggestion

private static void getInternalDictionarySuggestion(int theDictionaryId,
                                                    java.lang.String theQuery,
                                                    int theOffset,
                                                    int thePageSize,
                                                    com.google.gwt.core.client.JavaScriptObject theCallback)

transformWordSuggestions

private static com.google.gwt.core.client.JsArray transformWordSuggestions(java.util.List<WordSuggestion> theArray)

getJSArray

private static final com.google.gwt.core.client.JsArray getJSArray()

Intended for internal use.

transformWordSuggestion

private static com.google.gwt.core.client.JavaScriptObject transformWordSuggestion(WordSuggestion theWord)

Intended for internal use.

getDictionarySuggestions

private static void getDictionarySuggestions(int theDictionaryId,
                                             java.lang.String theQuery,
                                             int theOffset,
                                             int thePageSize,
                                             <any> theCallback)

Get a list of suggestions from a dictionary

Parameters:

theDictionaryId - the id of the dictionary

theQuery - the query (e.g. doc* would return document, document:pdf, etc)

theOffset - number to offset (page number * page size)

thePageSize - size of page

theCallback - function to return list of WordSuggestion objects to.

displayM3TAForm

private static void displayM3TAForm(DefaultCallback theCallback,
                                    java.lang.String theForms,
                                    com.google.gwt.core.client.JavaScriptObject theOpenCallback,
                                    boolean theHidePositive,
                                    boolean theHideNegative,
                                    java.lang.String thePositiveText,
                                    java.lang.String theNegativeText,
                                    java.lang.String theHeaderText)

Display a dialog with m3taforms in it for collection data for a js function

Parameters:

theCallback - function to call back with a Javascript object of field values, keyed by field ids

theForms - comma separated list of m3taforms to display

theOpenCallback - the action to take when the panel is loaded and ready, argument is the panel itself

theHidePositive - is hide positive button? (optional)

theHideNegative - is hide negative button? (optional)

thePositiveText - the positive button text (optional)

theNegativeText - the negative button text (optional)

theHeaderText - the text to display in the header (optional)

createM3TAForm

private static void createM3TAForm(DefaultCallback theSaveCallback,
                                   com.google.gwt.dom.client.Element theElement,
                                   java.lang.String theForms,
                                   int theWidth,
                                   int theHeight,
                                   com.google.gwt.core.client.JavaScriptObject theOpenCallback)

Creates a M3TAForm panel to be placed in the passed in element

Parameters:

theForms - the forms to create the panel for

theSaveCallback - function to call back with a Javascript object of field values, keyed by field ids

theElement - the element to replace with the panel

theWidth - width percent

theHeight - the height in px

theOpenCallback - the action to take when the panel is loaded and ready, argument is the panel itself

addM3TAForm

private static void addM3TAForm(NativeM3TAForm theM3TAForm)

Intended for internal use. Use displayM3TAForm or createM3TAForm Add a M3TAForm to the list of currently open M3TAForms.

Parameters:

theM3TAForm - The M3TAForm to add.

getM3TAForm

private static void getM3TAForm(java.lang.String theM3TAFormInstanceId)

Intended for internal use. Use displayM3TAForm or createM3TAForm Get a currently open M3TAForm by instance id.

Parameters:

theM3TAFormInstanceId - The instance id of the M3TAForm to get.

removeM3TAForm

private static void removeM3TAForm(java.lang.String theM3TAFormInstanceId)

Intended for internal use. Use displayM3TAForm or createM3TAForm Remove a currently open M3TAForm by instance id.

Parameters:

theM3TAFormInstanceId - The instance id of the M3TAForm to remove.

showAssetM3TAFormDialog

private static void showAssetM3TAFormDialog(int theAssetId,
                                            java.lang.String theForm,
                                            java.lang.String theHeaderText,
                                            java.lang.String theSaveButtonText)

Display a dialog with a metaform in it, correlated to a single asset

Parameters:

theAssetId - the asset id to edit

theForm - the form to display

theHeaderText - the text to display in the header (optional, will default to "Update Asset's Metadata")

theSaveButtonText - the text to display in the save button (optional, will default to "Update")