Mobile GlideForm (g_form) - Client

The Mobile GlideForm (g_form) API provides methods to work with forms on the mobile platform.

Use these methods in any script that targets a mobile device.

MobileGlideForm (g_form) - addDecoration(String fieldName, String icon, String text)

Adds a decorative icon next to a field.

Tableau 1. Parameters

Name	Type	Description
fieldName	String	The field name.
icon	String	The font icon to show next to the field.
text	String	The text title for the icon (used for screen readers).

Tableau 2. Returns

Type	Description
void

This example adds a VIP icon next to the caller.

function onChange(control, oldValue, newValue, isLoading) {
      // if the caller_id field is not present, then we can't add an icon anywhere
      if (!g_form.hasField('caller_id'))
          return;
      
      if (!newValue)
         return;
      
      g_form.getReference('caller_id', function(ref) {
      g_form.removeDecoration('caller_id', 'icon-star', 'VIP');
      
      if (ref.getValue('vip') == 'true')
           g_form.addDecoration('caller_id', 'icon-star', 'VIP');			
      });
      }

MobileGlideForm (g_form) - getLabel(String fieldName)

Gets the form label text.

Tableau 3. Parameters

Name	Type	Description
fieldName	String	The field name.

Tableau 4. Returns

Type	Description
String	The label text.

if (g_user.hasRole('itil')) {
      var oldLabel = g_form.getLabel('comments');
      g_form.setLabel('comments', oldLabel + ' (Customer visible)');
      }

MobileGlideForm (g_form) - hasField(String fieldName)

Determines if a field is present on the form.

Present means that it can be shown, not that it is visible.

Tableau 5. Parameters

Name	Type	Description
fieldName	String	The field to look for.

Tableau 6. Returns

Type	Description
Boolean	True if the field is present on the form; false, if it is not. On the form means that the field is part of g_form. It could still be hidden, read-only, mandatory, or invalid.

This example makes the assigned_to field mandatory if the assignment_group field is on the form.

if (g_form.hasField('assignment_group'))
      g_form.setMandatory('assigned_to', true);
    

MobileGlideForm (g_form) - removeDecoration(String fieldName, String icon, String text)

Removes a decorative icon from next to a field.

Tableau 7. Parameters

Name	Type	Description
fieldName	String	The field name.
icon	String	The icon to remove.
text	String	The text title for the icon.

Tableau 8. Returns

Type	Description
void

function onChange(control, oldValue, newValue, isLoading) {
      // if the caller_id field is not present, then we can't add an icon anywhere
      if (!g_form.hasField('caller_id'))
           return;
      
      if (!newValue)
           return;
      
      g_form.getReference('caller_id', function(ref) {
           g_form.removeDecoration('caller_id', 'icon-star', 'VIP');
      
           if (ref.getValue('vip') == 'true')
                g_form.addDecoration('caller_id', 'icon-star', 'VIP');			
      });
      }

MobileGlideForm (g_form) - setLabel(String fieldName, String label)

Sets the form label text.

Tableau 9. Parameters

Name	Type	Description
fieldName	String	The field name.
label	String	The field label text.

Tableau 10. Returns

Type	Description
void

This example changes the comments label.

if (g_user.hasRole('itil')) {
      var oldLabel = g_form.getLabel('comments');
      g_form.setLabel('comments', oldLabel + ' (Customer visible)');
      }