ui.igWidget

Dependencies

jquery.js
jquery.ui.core.js
jquery.ui.widget.js
infragistics.util.js
infragistics.util.jquery.js

Inherits

  • language

    Type:
    string
    Default:
    "en"

    Set/Get the locale language setting for the widget.

    Code Sample

     
    					//Initialize
    				$(".selector").igWidget({
    					language: "ja"
    				});
    
    				// Get
    				var language = $(".selector").igWidget("option", "language");
    
    				// Set
    				$(".selector").igWidget("option", "language", "ja");
    			 
  • locale

    Type:
    object
    Default:
    null

    Set/Get the locale setting for the widget.

    Code Sample

     
    					//Initialize
    				$(".selector").igWidget({
    					locale: {}
    				});
    
    				// Get
    				var locale = $(".selector").igWidget("option", "locale");
    
    				// Set
    				$(".selector").igWidget("option", "locale", {});
    			 
  • regional

    Type:
    enumeration
    Default:
    defaults

    Set/Get the regional setting for the widget.

    Code Sample

     
    				//Initialize
    				$(".selector").igWidget({
    					regional: "ja"
    				});
    				// Get
    				var regional = $(".selector").igWidget("option", "regional");
    				// Set
    				$(".selector").igWidget("option", "regional", "ja");
    			 
The current widget has no events.
  • changeGlobalLanguage

    .igWidget( "changeGlobalLanguage" );

    Changes the widget language to global language. Global language is the value in $.ig.util.language.

    Code Sample

     
    				$(".selector").igWidget("changeGlobalLanguage");
    			 
  • changeGlobalRegional

    .igWidget( "changeGlobalRegional" );

    Changes the widget regional settins to global regional settings. Global regional settings are container in $.ig.util.regional.

    Code Sample

     
    				$(".selector").igWidget("changeGlobalRegional");
    			 
  • changeLocale

    .igWidget( "changeLocale", $container:object );

    Changes the all locales contained into a specified container to the language specified in options.language
    Note that this method is for rare scenarios, use language or locale option setter.

    • $container
    • Type:object
    • Optional parameter - if not set it would use the element of the widget as $container.

    Code Sample

     
    				$(".selector").igWidget("changeLocale");
    			 
  • destroy

    .igWidget( "destroy" );

    Destroy is part of the jQuery UI widget API and does the following:
    1. Remove custom CSS classes that were added.
    2. Unwrap any wrapping elements such as scrolling divs and other containers.
    3. Unbind all events that were bound.

    Code Sample

     
    					$(".selector").igWidget("destroy");
    				 
The current widget has no css classes.

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.