CJuiDroppable
| Пакет | zii.widgets.jui |
|---|---|
| Наследование | класс CJuiDroppable » CJuiWidget » CWidget » CBaseController » CComponent |
| С версии | 1.1 |
| Исходный код | framework/zii/widgets/jui/CJuiDroppable.php |
CJuiDroppable отображает виджет перетаскивания.
CJuiDroppable инкапсулирует плагин JUI Droppable.
Для использования этого виджета, вы можете вставить следующий код в представление:
Настроив свойство options, вы можете указать параметры, которые нужно передать плагину JUI Droppable. Обратитесь к документации JUI Droppable API для возможных параметров (имя-значение) и к странице JUI Droppable для общего описания и демонстрации.
CJuiDroppable инкапсулирует плагин JUI Droppable.
Для использования этого виджета, вы можете вставить следующий код в представление:
$this->beginWidget('zii.widgets.jui.CJuiDroppable',array(
// additional javascript options for the droppable plugin
'options'=>array(
'scope'=>'myScope',
),
));
echo 'Your droppable content here';
$this->endWidget();
Настроив свойство options, вы можете указать параметры, которые нужно передать плагину JUI Droppable. Обратитесь к документации JUI Droppable API для возможных параметров (имя-значение) и к странице JUI Droppable для общего описания и демонстрации.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| actionPrefix | строка | префикс к идентификаторам действий. | CWidget |
| controller | CController | Возвращает контроллер, к которому относится этот виджет. | CWidget |
| cssFile | смешанный тип | имя файла CSS темы. | CJuiWidget |
| htmlOptions | массив | атрибуты HTML, которые должны быть отображены в теге HTML, представляющем виджет JUI. | CJuiWidget |
| id | строка | Возвращает ID виджета или генерирует новый, если запрошено. | CWidget |
| options | массив | начальные параметры JavaScript, которые должны быть переданы плагину JUI. | CJuiWidget |
| owner | CBaseController | Возвращает владельца/создателя этого виджета. | CWidget |
| scriptFile | смешанный тип | основной файл JavaScript JUI. | CJuiWidget |
| scriptUrl | строка | корневой URL, который содержит все файлы JavaScript JUI. | CJuiWidget |
| skin | смешанный тип | имя скина, используемого этим виджетом. | CWidget |
| tagName | строка | имя тега HTML элемента перетаскивания. | CJuiDroppable |
| theme | строка | имя темы JUI. | CJuiWidget |
| themeUrl | строка | корневой URL, который содержит все папки тем JUI. | CJuiWidget |
| viewPath | строка | Возвращает директорию, содержащую файлы представлений для этого виджета. | CWidget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CWidget |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение в зависимости от его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| actions() | Возвращает список действий, используемых этим виджетом. | CWidget |
| asa() | Возвращает объект поведения с указанным именем. | CComponent |
| attachBehavior() | Прикрепляет поведение к данному компоненту. | CComponent |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | CComponent |
| attachEventHandler() | Прикрепляет обработчик событий к событию. | CComponent |
| beginCache() | Начинает фрагментарное кэширование. | CBaseController |
| beginClip() | Начинает запись клипа. | CBaseController |
| beginContent() | Начинает отображение содержимого, которое должно быть оформлено указанным представлением. | CBaseController |
| beginWidget() | Создаёт виджет и выполняет его. | CBaseController |
| canGetProperty() | Определяет, может ли свойство быть прочитано. | CComponent |
| canSetProperty() | Определяет, может ли свойство быть установлено. | CComponent |
| createWidget() | Создаёт виджет и инициализирует его. | CBaseController |
| detachBehavior() | Отсоединяет поведение от компонента. | CComponent |
| detachBehaviors() | Отсоединяет все поведения от компонента. | CComponent |
| detachEventHandler() | Отсоединяет существующего обработчика событий. | CComponent |
| disableBehavior() | Отключает присоединённое поведение. | CComponent |
| disableBehaviors() | Отключает все прикреплённые поведения к этому компоненту. | CComponent |
| enableBehavior() | Включает присоединённое поведение. | CComponent |
| enableBehaviors() | Включает все присоединённые поведения к этому компоненту. | CComponent |
| endCache() | Заканчивает фрагментарное кэширование. | CBaseController |
| endClip() | Заканчивает запись клипа. | CBaseController |
| endContent() | Заканчивает отображение содержимого. | CBaseController |
| endWidget() | Заканчивает выполнение указанного виджета. | CBaseController |
| evaluateExpression() | Вычисляет выражение PHP или обратный вызов в контексте данного компонента. | CComponent |
| getController() | Возвращает контроллер, к которому принадлежит этот виджет. | CWidget |
| getEventHandlers() | Возвращает список прикреплённых обработчиков событий для события. | CComponent |
| getId() | Возвращает идентификатор виджета или генерирует новый, если запрошено. | CWidget |
| getOwner() | Возвращает владельца/создателя этого виджета. | CWidget |
| getViewFile() | Ищет файл сценария представления по имени представления. | CWidget |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для этого виджета. | CWidget |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли у указанного события прикреплённые обработчики. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| init() | Отображает открывающий тег элемента droppable. | CJuiDroppable |
| raiseEvent() | Возбуждает событие. | CComponent |
| render() | Отображает представление. | CWidget |
| renderFile() | Отображает файл представления. | CBaseController |
| renderInternal() | Отображает файл представления. | CBaseController |
| run() | Отображает закрывающий тег элемента droppable. | CJuiDroppable |
| setId() | Устанавливает идентификатор виджета. | CWidget |
| widget() | Создаёт виджет и выполняет его. | CBaseController |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| registerCoreScripts() | Регистрирует ядро скриптов. | CJuiWidget |
| registerScriptFile() | Регистрирует файл JavaScript под scriptUrl. | CJuiWidget |
| resolvePackagePath() | Определяет путь к установке пакета JUI. | CJuiWidget |
Подробное описание свойств
tagName свойство
public string $tagName;
Имя HTML-тега элемента Droppable. По умолчанию 'div'.
Подробное описание методов
init() метод
public void init() |
Исходный код: framework/zii/widgets/jui/CJuiDroppable.php#55 (показать)
public function init()
{
parent::init();
$id=$this->getId();
if(isset($this->htmlOptions['id']))
$id=$this->htmlOptions['id'];
else
$this->htmlOptions['id']=$id;
$options=CJavaScript::encode($this->options);
Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').droppable($options);");
echo CHtml::openTag($this->tagName,$this->htmlOptions)."\n";
}
Отображает открывающий тег элемента droppable. Этот метод также регистрирует необходимый JavaScript-код.
run() метод
public void run() |
Исходный код: framework/zii/widgets/jui/CJuiDroppable.php#74 (показать)
public function run()
{
echo CHtml::closeTag($this->tagName);
}
Отображает закрывающий тег элемента droppable.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CJuiDroppable
