jb.gwt_main_modules.base_widgets.client.js_api.mf

Class NativeField

java.lang.Object

jb.gwt_main_modules.base_widgets.client.js_api.mf.NativeField

public class NativeField
extends java.lang.Object

Wraps a field on a M3TAForm to make it accessible to client side javascript.

Constructor Summary

Constructors

Constructor and Description
NativeField()

Method Summary

Modifier and Type	Method and Description
com.google.gwt.user.client.Element	getElement() Gets the element of the field for operations on it.
java.lang.String	getErrorMessage() Get the error message.
java.lang.String	getID() Get the field's id.
java.lang.String	getName() Get the name.
java.lang.String	getUI() Get the ui type.
java.lang.String	getValidator() Get the validator.
java.lang.String	getValue() Get the value of the field, can't get RDB values.
boolean	isHierarchical() Is hierarchical field?
boolean	isInvalid() Is the field's value valid?
boolean	isReadOnly() Is the field read only?
boolean	isVisible() Is the field visible?
static void	javascriptConstructor(jb.gwt_main_modules.base_widgets.client.panels.xmpfieldedit.XmpEditField theDelegateField) The field wrapper constructor.
void	resetField() Set back to default state
void	setCSVAction(java.lang.String theXMPEditAction) Change the value of the CSV field's associated action.
void	setCSVDefaultAction(java.lang.String theXMPEditAction) Change the value of the CSV field's associated myDefaultAction variable.
void	setCustomButton(java.lang.String theIconName, java.lang.String theButtonText, java.lang.String theJavascriptCommand) Add custom button next to field with passed in javascript Example to add button that looks like a person icon, has hover text, and adds the current user's username on click to the associated field.
void	setEnabled(boolean theEnabled) Set the field disabled or enabled.
void	setHelpMessage(java.lang.String theMessage) Create a help button w/hover, tippy text attached
void	setInvalid(boolean theIsInvalid, java.lang.String theErrorMessage) Set the validity of the field's value.
void	setLabel(java.lang.String theLabel) Set the field label.
void	setMaxLength(int theMaxLength) Set max length accepted by the field
void	setMessage(java.lang.String theMessage) Set a message for the field
void	setNotEmpty(boolean theIsNotEmpty) Set the field as being not empty (or removing not empty if added via API before).
void	setPlaceholderText(java.lang.String thePlaceholderText) Text to display in the textbox if no text has been entered.
void	setReadOnly(boolean theReadOnly, boolean theRefreshParent) Set the field read only.
static void	setupAPI() Setup the field wrapper constructor and functions.
void	setValue(java.lang.String theNewValue) Set the field's value and mark it dirty.
java.lang.String	setValueTransformer(java.lang.String theValueTransformationScript) Example to append 2 to the end of a returned value: "return theValue + '2'"
void	setVisible(boolean theVisible) Set the field visible or hidden.

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeField

public NativeField()

Method Detail

setupAPI

public static void setupAPI()

Setup the field wrapper constructor and functions.

javascriptConstructor

public static void javascriptConstructor(jb.gwt_main_modules.base_widgets.client.panels.xmpfieldedit.XmpEditField theDelegateField)

The field wrapper constructor.

Parameters:

theDelegateField - The field to wrap.

setValueTransformer

public java.lang.String setValueTransformer(java.lang.String theValueTransformationScript)

Example to append 2 to the end of a returned value: "return theValue + '2'"

Parameters:

theValueTransformationScript -

Returns:

transformed string value

getName

public java.lang.String getName()

Get the name.

Returns:

the field name

setMaxLength

public void setMaxLength(int theMaxLength)

Set max length accepted by the field

Parameters:

theMaxLength - the max length integer, -1 will unset any value applied

setNotEmpty

public void setNotEmpty(boolean theIsNotEmpty)

Set the field as being not empty (or removing not empty if added via API before). Note if the field has an actual not empty validator, setting this will have no impact.

Parameters:

theIsNotEmpty - Should we say the field value is mandatory or not [true|false]?

getUI

public java.lang.String getUI()

Get the ui type.

Returns:

validator value

getValidator

public java.lang.String getValidator()

Get the validator.

Returns:

validator value

isHierarchical

public boolean isHierarchical()

Is hierarchical field?

Returns:

true if field is hierarchical, false otherwise

getID

public java.lang.String getID()

Get the field's id.

Returns:

Field id [namespace fieldname]

getValue

public java.lang.String getValue()

Get the value of the field, can't get RDB values.

Returns:

fields value

setCSVDefaultAction

public void setCSVDefaultAction(java.lang.String theXMPEditAction)

Change the value of the CSV field's associated myDefaultAction variable. Not for use with non-CSV fields. Supported actions: add, replace_selected.

Parameters:

theXMPEditAction - the default action to be used when a field is clicked. Single value fields are by default XMPEditAction.replace_selected, while multi-value fields are by default XMPEditAction.add.

getElement

public com.google.gwt.user.client.Element getElement()

Gets the element of the field for operations on it.

setCSVAction

public void setCSVAction(java.lang.String theXMPEditAction)

Change the value of the CSV field's associated action. Not for use with non-CSV fields. Supported actions: add, replace_selected, noaction.

Parameters:

theXMPEditAction - the action to be used when a field's form is submitted. Single value fields are by default XMPEditAction.replace_selected, while multi-value fields are by default XMPEditAction.add.

setValue

public void setValue(java.lang.String theNewValue)

Set the field's value and mark it dirty.

Parameters:

theNewValue - The value to set the field to.

resetField

public void resetField()

Set back to default state

isVisible

public boolean isVisible()

Is the field visible?

Returns:

Is the field visible?

setVisible

public void setVisible(boolean theVisible)

Set the field visible or hidden.

Parameters:

theVisible - Should the field be visible or hidden?

setEnabled

public void setEnabled(boolean theEnabled)

Set the field disabled or enabled.

Parameters:

theEnabled - Should the field be visible or hidden?

setInvalid

public void setInvalid(boolean theIsInvalid,
                       java.lang.String theErrorMessage)

Set the validity of the field's value.

Parameters:

theIsInvalid - Is this field's value invalid?

theErrorMessage - The error message to display in tooltip when hovering over the invalid field.

setMessage

public void setMessage(java.lang.String theMessage)

Set a message for the field

Parameters:

theMessage - the message to set

setHelpMessage

public void setHelpMessage(java.lang.String theMessage)

Create a help button w/hover, tippy text attached

Parameters:

theMessage - the message to display when hovering over help button

setCustomButton

public void setCustomButton(java.lang.String theIconName,
                            java.lang.String theButtonText,
                            java.lang.String theJavascriptCommand)

Add custom button next to field with passed in javascript Example to add button that looks like a person icon, has hover text, and adds the current user's username on click to the associated field. theCurrentField.setCustomButton("person", "AutoFill User Name", "theCurrentField.setValue(parent.MBAPI.getUserName());");

Parameters:

theIconName - the material icon name

theJavascriptCommand - javascript code to execute. Will pass in the metaform and field as with other APIs (`theCurrentM3TAForm` and `theCurrentField`)

setPlaceholderText

public void setPlaceholderText(java.lang.String thePlaceholderText)

Text to display in the textbox if no text has been entered.

Parameters:

thePlaceholderText - the text to display

isInvalid

public boolean isInvalid()

Is the field's value valid?

Returns:

Is the field's value valid?

getErrorMessage

public java.lang.String getErrorMessage()

Get the error message.

Returns:

The error message.

isReadOnly

public boolean isReadOnly()

Is the field read only?

Returns:

is read only

setReadOnly

public void setReadOnly(boolean theReadOnly,
                        boolean theRefreshParent)

Set the field read only. Note: theRefreshParent parameter is optional, with a default value of true. A value of true can interfere with other field settings, such as visibility. If that occurs, set this value to false.

Parameters:

theReadOnly - Should the field be read only

theRefreshParent - Should we redraw the entire form after setting? Optional parameter. Default is true.

setLabel

public void setLabel(java.lang.String theLabel)

Set the field label.

Parameters:

theLabel - The field label.