com.vaadin.polymer.neon.element.NeonAnimatedPagesElement Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from neon-animation project by The Polymer Authors
* that is licensed with http://polymer.github.io/LICENSE.txt license.
*/
package com.vaadin.polymer.neon.element;
import com.vaadin.polymer.elemental.*;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.core.client.JsArray;
import com.google.gwt.core.client.js.JsProperty;
import com.google.gwt.core.client.js.JsType;
/**
* neon-animated-pages manages a set of pages and runs an animation when switching between them. Its
children pages should implement Polymer.NeonAnimatableBehavior and define entry and exit
animations to be run when switching to or switching out of the page.
*/
@JsType
public interface NeonAnimatedPagesElement extends HTMLElement {
public static final String TAG = "neon-animated-pages";
public static final String SRC = "neon-animation/neon-animation.html";
/**
*
*
* JavaScript Info:
* @property activateEvent
* @type String
*
*/
@JsProperty String getActivateEvent();
/**
*
*
* JavaScript Info:
* @property activateEvent
* @type String
*
*/
@JsProperty void setActivateEvent(String value);
/**
* if true, the initial page selection will also be animated according to its animation config.
*
* JavaScript Info:
* @property animateInitialSelection
* @type Boolean
*
*/
@JsProperty boolean getAnimateInitialSelection();
/**
* if true, the initial page selection will also be animated according to its animation config.
*
* JavaScript Info:
* @property animateInitialSelection
* @type Boolean
*
*/
@JsProperty void setAnimateInitialSelection(boolean value);
/**
*
*
* JavaScript Info:
* @property listeners
* @type Object
*
*/
@JsProperty JavaScriptObject getListeners();
/**
*
*
* JavaScript Info:
* @property listeners
* @type Object
*
*/
@JsProperty void setListeners(JavaScriptObject value);
/**
*
*
* JavaScript Info:
* @property observers
* @type Array
*
*/
@JsProperty JsArray getObservers();
/**
*
*
* JavaScript Info:
* @property observers
* @type Array
*
*/
@JsProperty void setObservers(JsArray value);
/**
* Used to assign the closest resizable ancestor to this resizable
if the ancestor detects a request for notifications.
*
* JavaScript Info:
* @method assignParentResizable
* @param {} parentResizable
* @behavior NeonAnimatedPages
*/
void assignParentResizable(JavaScriptObject parentResizable);
/**
* Can be called to manually notify a resizable and its descendant
resizables of a resize change.
*
* JavaScript Info:
* @method notifyResize
* @behavior NeonAnimatedPages
*/
void notifyResize();
/**
* This method can be overridden to filter nested elements that should or
should not be notified by the current element. Return true if an element
should be notified, or false if it should not be notified.
*
* JavaScript Info:
* @method resizerShouldNotify
* @param {HTMLElement} element
* @behavior NeonAnimatedPages
*/
void resizerShouldNotify(JavaScriptObject element);
/**
* Used to remove a resizable descendant from the list of descendants
that should be notified of a resize change.
*
* JavaScript Info:
* @method stopResizeNotificationsFor
* @param {} target
* @behavior NeonAnimatedPages
*/
void stopResizeNotificationsFor(JavaScriptObject target);
/**
*
*
* JavaScript Info:
* @method attached
* @behavior NeonAnimatedPages
*/
void attached();
/**
*
*
* JavaScript Info:
* @method detached
* @behavior NeonAnimatedPages
*/
void detached();
/**
* If you want to use the attribute value of an element for selected instead of the index,
set this to the name of the attribute.
*
* JavaScript Info:
* @property attrForSelected
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty String getAttrForSelected();
/**
* If you want to use the attribute value of an element for selected instead of the index,
set this to the name of the attribute.
*
* JavaScript Info:
* @property attrForSelected
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty void setAttrForSelected(String value);
/**
*
*
* JavaScript Info:
* @property excludedLocalNames
* @type Object
* @behavior NeonAnimatedPages
*/
@JsProperty JavaScriptObject getExcludedLocalNames();
/**
*
*
* JavaScript Info:
* @property excludedLocalNames
* @type Object
* @behavior NeonAnimatedPages
*/
@JsProperty void setExcludedLocalNames(JavaScriptObject value);
/**
* Returns the index of the given item.
*
* JavaScript Info:
* @method indexOf
* @param {Object} item
* @behavior NeonAnimatedPages
*/
void indexOf(JavaScriptObject item);
/**
* Returns an array of selectable items.
*
* JavaScript Info:
* @method items
* @behavior NeonAnimatedPages
*/
void items();
/**
* Selects the given value.
*
* JavaScript Info:
* @method select
* @param {string} value
* @behavior NeonAnimatedPages
*/
void select(String value);
/**
* Selects the next item.
*
* JavaScript Info:
* @method selectNext
* @behavior NeonAnimatedPages
*/
void selectNext();
/**
* Selects the previous item.
*
* JavaScript Info:
* @method selectPrevious
* @behavior NeonAnimatedPages
*/
void selectPrevious();
/**
* This is a CSS selector sting. If this is set, only items that matches the CSS selector
are selectable.
*
* JavaScript Info:
* @property selectable
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty String getSelectable();
/**
* This is a CSS selector sting. If this is set, only items that matches the CSS selector
are selectable.
*
* JavaScript Info:
* @property selectable
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty void setSelectable(String value);
/**
* Gets or sets the selected element. The default is to use the index of the item.
*
* JavaScript Info:
* @property selected
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty String getSelected();
/**
* Gets or sets the selected element. The default is to use the index of the item.
*
* JavaScript Info:
* @property selected
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty void setSelected(String value);
/**
* The attribute to set on elements when selected.
*
* JavaScript Info:
* @property selectedAttribute
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty String getSelectedAttribute();
/**
* The attribute to set on elements when selected.
*
* JavaScript Info:
* @property selectedAttribute
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty void setSelectedAttribute(String value);
/**
* The class to set on elements when selected.
*
* JavaScript Info:
* @property selectedClass
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty String getSelectedClass();
/**
* The class to set on elements when selected.
*
* JavaScript Info:
* @property selectedClass
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty void setSelectedClass(String value);
/**
* Returns the currently selected item.
*
* JavaScript Info:
* @property selectedItem
* @type Object
* @behavior NeonAnimatedPages
*/
@JsProperty JavaScriptObject getSelectedItem();
/**
* Returns the currently selected item.
*
* JavaScript Info:
* @property selectedItem
* @type Object
* @behavior NeonAnimatedPages
*/
@JsProperty void setSelectedItem(JavaScriptObject value);
/**
* Cancels the currently running animation.
*
* JavaScript Info:
* @method cancelAnimation
* @behavior NeonAnimatedPages
*/
void cancelAnimation();
/**
* Plays an animation with an optional type.
*
* JavaScript Info:
* @method playAnimation
* @param {string=} type
* @param {!Object=} cookie
* @behavior NeonAnimatedPages
*/
void playAnimation(JavaScriptObject type, JavaScriptObject cookie);
/**
* Animation configuration. See README for more info.
*
* JavaScript Info:
* @property animationConfig
* @type Object
* @behavior NeonAnimatable
*/
@JsProperty JavaScriptObject getAnimationConfig();
/**
* Animation configuration. See README for more info.
*
* JavaScript Info:
* @property animationConfig
* @type Object
* @behavior NeonAnimatable
*/
@JsProperty void setAnimationConfig(JavaScriptObject value);
/**
* Convenience property for setting an ‘entry’ animation. Do not set animationConfig.entry
manually if using this. The animated node is set to this if using this property.
*
* JavaScript Info:
* @property entryAnimation
* @type String
* @behavior NeonAnimatable
*/
@JsProperty String getEntryAnimation();
/**
* Convenience property for setting an ‘entry’ animation. Do not set animationConfig.entry
manually if using this. The animated node is set to this if using this property.
*
* JavaScript Info:
* @property entryAnimation
* @type String
* @behavior NeonAnimatable
*/
@JsProperty void setEntryAnimation(String value);
/**
* Convenience property for setting an ‘exit’ animation. Do not set animationConfig.exit
manually if using this. The animated node is set to this if using this property.
*
* JavaScript Info:
* @property exitAnimation
* @type String
* @behavior NeonAnimatable
*/
@JsProperty String getExitAnimation();
/**
* Convenience property for setting an ‘exit’ animation. Do not set animationConfig.exit
manually if using this. The animated node is set to this if using this property.
*
* JavaScript Info:
* @property exitAnimation
* @type String
* @behavior NeonAnimatable
*/
@JsProperty void setExitAnimation(String value);
/**
* An element implementing Polymer.NeonAnimationRunnerBehavior calls this method to configure
an animation with an optional type. Elements implementing Polymer.NeonAnimatableBehavior
should define the property animationConfig, which is either a configuration object
or a map of animation type to array of configuration objects.
*
* JavaScript Info:
* @method getAnimationConfig
* @param {} type
* @behavior NeonAnimatable
*/
void getAnimationConfig(JavaScriptObject type);
}