You are here: Home / 2013 / Июль / 16 / mapSurfer — javascript-интерфейс — widgets

mapSurfer — javascript-интерфейс — widgets

16 июля 2013 admin
назад
mapSurfer / javascript-интерфейс/ Виджеты

Класс, от которого наследуются все виджеты.

Параметры, которые можно указать при создании экземпляра любого виджета, класс которого наследуется от GP.Widget.

options	
mainElement
// объект опций для виджета, доступен в свойстве options
// id DOM елемента или объект jQuery, доступен в свойстве _mainElement

Пример написания виджета

GP.Widget.MyWidget = GP.Widget.extend({
	_createWidget: function(){	
		...
	}

});
		
// наследование от GP.Widget
// конструктор
// действия виджета

Методы

Метод Описание Параметры
findElem(selector) Поиск DOM элементов внутри виджета с помощью jQuery. selector — jQuery селектор
_bind(elem,event,data,fn) Выполнить функцию при срабатываниисобытия у элемента elem — элемент
event — событие элемента
data — параметры для функции
fn — функция
_onResize() Функция выполняется при изменении размеров окна. в своем виджете эту функцию можно переопределить. —

Виджет для блокировки экрана. Отображается во время загрузки.

Методы

Метод Возвращает Описание
show() — затемнить экран
showLoader() — затемнить экран и показать песочные часы
close() — выключить виджет

Виджет, показывающий стилизованное системное сообщение.

Методы

Метод Описание Параметры
show() показать сообщение —
setStatus(status) установить статус сообщения 
status:
		200	-	"действие выполнено"
		403	-	"Доступ ограничен"
		404	-	"Не найдено"
по умолчанию "ошибка"
setText(text) становить текст сообщения text — текст сообщения

События

Объект GP.widgets.authenticationВиджет авторизации.МетодыСобытияОбъект GP.widgets.baseLayerSelectorВиджет для выбора базового слоя.МетодыСобытияОбъект GP.widgets.curtainLayerВиджет шторки. Шторка автоматически убирается, если слой перестает быть активным или убирается левая панель.МетодыАктивирование шторки.Для слоя mapLayer.

if(GP.widgets.curtainLayer && mapLayer 
         && GP.widgets.curtainLayer.getLayer() != mapLayer )
	GP.widgets.curtainLayer.setLayer(mapLayer);	
GP.widgets.curtainLayer.switchCurtain();
		


// установка слоя шторке
// переключение шторки

Деактивирование шторки.

GP.widgets.curtainLayer.hide();

класс GP.Widget.DialogBoxВиджет диалогового окна.

var myDialogBox = new GP.Widget.DialogBox(
		{				
			dialogBoxId:"myDialogBoxId",	
			width:110,	
			top:87,		
			left:106	
		},
		"#wrap");		
// создание диалогового окна
// пример опций(options)
// id DOM елемента окна
// ширина окна
// отступ сверху
// отступ слева

// id елемента, в который необходимо поместить окно

МетодыСобытиякласс GP.Widget.ButtonВиджет кнопки.Пример использования кнопки

GP.widgets.myButton = new GP.Widget.Button({buttonId:"muButtonId"});
 GP.widgets.myButton.on(
	"buttonClick",
	this.click,
	this);
//  создание кнопки. buttonId - id элемента кнопки
// слушание события нажатия кнопки
// событие
// функция, которую необходимо выполнить при нажатии
// контекст, в котором необходимо выполнить функцию

МетодыСобытиякласс GP.Widget.GeoCodingВиджет для поиска объектов на карте по строке.Опции объекта

options:{
	label: '',
	title: '',
	items: [
		{
		 label: '',
		 initial: false
		}
	],
	onClick: function () {
	}
}

класс GP.Widget.SelectableButtonВиджет кнопки с выплывающим меню.класс GP.Widget.UserPanelВиджет верхней панели с авторизацией.

Событие Параметры Описание
«closeAlert» alert — объект сообщения Сообщение закрыто.
Метод Описание Параметры
show() показать виджет авторизации —
hide() скрыть —
remove() удалить виджет авторизации —
Событие Параметры Описание
«authenticationSuccess» user — данные пользователя Пользователь прошел авторизацию
Метод Описание Параметры
currentBaseLayer() возвращает текущий базовый слой —
Событие Параметры Описание
«changeBaseLayer» baseLayer — объект базового слоя Выбран новый базовый слой
Метод Описание возвращает
isShow() активность виджета возвращает true или false, активна ли шторка
curtainOn() показать шторку —
curtainOff() выключить шторку —
switchCurtain() включить/выключить шторку —
getLayer() — слой, для которого включена шторка
setLayer() установить слой для шторки —
hide() убрать шторку —
Метод Описание возвращает
close() закрыть —
clear() очистить содержимое —
isReady() готовность dialogBox возвращает true|false
show() показать dialogBox —
isShow() показывается ли dialogBox возвращает true|false
setTitle(title) устанавливает заголовок dialogBox —
setContainer(container) устанавливает содержимое dialogBox —
width(width) устанавливает ширину dialogBox —
top(top) устанавливает отступ сверху dialogBox —
left(left) устанавливает отступ слева dialogBox —
remove() удаляет dialogBox —
Событие Параметры Описание
«readyDialog» dialog — объект диалогового окна Диалоговое окно готово к использованию.
«closeDialog» dialog — объект диалогового окна Диалоговое окно закрыто.
Метод Описание
display(bool) 
bool:
	true - показать кнопку
	false - скрыть кнопку
Событие Описание Параметры
«buttonClick» Возникает при клике на кнопку button — объект кнопки
Posted in