com.vaadin.polymer.paper.element.PaperTabsElement Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from paper-tabs project by The Polymer Authors
* that is licensed with http://polymer.github.io/LICENSE.txt license.
*/
package com.vaadin.polymer.paper.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;
/**
* paper-tabs makes it easy to explore and switch between different views or functional aspects of
an app, or to browse categorized data sets.
* Use selected property to get or set the selected tab.
* Example:
* <paper-tabs selected="0">
* <paper-tab>TAB 1</paper-tab>
* <paper-tab>TAB 2</paper-tab>
* <paper-tab>TAB 3</paper-tab>
* </paper-tabs>
*
*
*
See paper-tab for more information about
paper-tab.
* A common usage for paper-tabs is to use it along with iron-pages to switch
between different views.
* <paper-tabs selected="{{selected}}">
* <paper-tab>Tab 1</paper-tab>
* <paper-tab>Tab 2</paper-tab>
* <paper-tab>Tab 3</paper-tab>
* </paper-tabs>
*
* <iron-pages selected="{{selected}}">
* <div>Page 1</div>
* <div>Page 2</div>
* <div>Page 3</div>
* </iron-pages>
*
*
*
*
To use links in tabs, add link attribute to paper-tab and put an <a>
element in paper-tab.
* Example:
* <paper-tabs selected="0">
* <paper-tab link>
* <a href="#link1" class="horizontal center-center layout">TAB ONE</a>
* </paper-tab>
* <paper-tab link>
* <a href="#link2" class="horizontal center-center layout">TAB TWO</a>
* </paper-tab>
* <paper-tab link>
* <a href="#link3" class="horizontal center-center layout">TAB THREE</a>
* </paper-tab>
* </paper-tabs>
*
*
*
Styling
* The following custom properties and mixins are available for styling:
*
*
*
* Custom property
* Description
* Default
*
*
*
*
* --paper-tabs-selection-bar-colorColor for the selection bar
* --paper-yellow-a100
*
* --paper-tabsMixin applied to the tabs
* {}
*
*
*/
@JsType
public interface PaperTabsElement extends HTMLElement {
public static final String TAG = "paper-tabs";
public static final String SRC = "paper-tabs/paper-tabs.html";
/**
* If true, the tabs are aligned to bottom (the selection bar appears at the top).
*
* JavaScript Info:
* @property alignBottom
* @type Boolean
*
*/
@JsProperty boolean getAlignBottom();
/**
* If true, the tabs are aligned to bottom (the selection bar appears at the top).
*
* JavaScript Info:
* @property alignBottom
* @type Boolean
*
*/
@JsProperty void setAlignBottom(boolean value);
/**
* If true, dragging on the tabs to scroll is disabled.
*
* JavaScript Info:
* @property disableDrag
* @type Boolean
*
*/
@JsProperty boolean getDisableDrag();
/**
* If true, dragging on the tabs to scroll is disabled.
*
* JavaScript Info:
* @property disableDrag
* @type Boolean
*
*/
@JsProperty void setDisableDrag(boolean value);
/**
* If true, scroll buttons (left/right arrow) will be hidden for scrollable tabs.
*
* JavaScript Info:
* @property hideScrollButtons
* @type Boolean
*
*/
@JsProperty boolean getHideScrollButtons();
/**
* If true, scroll buttons (left/right arrow) will be hidden for scrollable tabs.
*
* JavaScript Info:
* @property hideScrollButtons
* @type Boolean
*
*/
@JsProperty void setHideScrollButtons(boolean value);
/**
* If true, the bottom bar to indicate the selected tab will not be shown.
*
* JavaScript Info:
* @property noBar
* @type Boolean
*
*/
@JsProperty boolean getNoBar();
/**
* If true, the bottom bar to indicate the selected tab will not be shown.
*
* JavaScript Info:
* @property noBar
* @type Boolean
*
*/
@JsProperty void setNoBar(boolean value);
/**
* If true, the slide effect for the bottom bar is disabled.
*
* JavaScript Info:
* @property noSlide
* @type Boolean
*
*/
@JsProperty boolean getNoSlide();
/**
* If true, the slide effect for the bottom bar is disabled.
*
* JavaScript Info:
* @property noSlide
* @type Boolean
*
*/
@JsProperty void setNoSlide(boolean value);
/**
* If true, ink ripple effect is disabled.
*
* JavaScript Info:
* @property noink
* @type Boolean
*
*/
@JsProperty boolean getNoink();
/**
* If true, ink ripple effect is disabled.
*
* JavaScript Info:
* @property noink
* @type Boolean
*
*/
@JsProperty void setNoink(boolean value);
/**
* If true, tabs are scrollable and the tab width is based on the label width.
*
* JavaScript Info:
* @property scrollable
* @type Boolean
*
*/
@JsProperty boolean getScrollable();
/**
* If true, tabs are scrollable and the tab width is based on the label width.
*
* JavaScript Info:
* @property scrollable
* @type Boolean
*
*/
@JsProperty void setScrollable(boolean value);
/**
*
*
* JavaScript Info:
* @property selectable
* @type String
*
*/
@JsProperty String getSelectable();
/**
*
*
* JavaScript Info:
* @property selectable
* @type String
*
*/
@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
*
*/
@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
*
*/
@JsProperty void setSelected(String value);
/**
*
*
* JavaScript Info:
* @property hostAttributes
* @type Object
*
*/
@JsProperty JavaScriptObject getHostAttributes();
/**
*
*
* JavaScript Info:
* @property hostAttributes
* @type Object
*
*/
@JsProperty void setHostAttributes(JavaScriptObject value);
/**
*
*
* JavaScript Info:
* @property listeners
* @type Object
*
*/
@JsProperty JavaScriptObject getListeners();
/**
*
*
* JavaScript Info:
* @property listeners
* @type Object
*
*/
@JsProperty void setListeners(JavaScriptObject 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();
/**
*
*
* JavaScript Info:
* @property keyBindings
* @type Object
* @behavior PaperTabs
*/
@JsProperty JavaScriptObject getKeyBindings();
/**
*
*
* JavaScript Info:
* @property keyBindings
* @type Object
* @behavior PaperTabs
*/
@JsProperty void setKeyBindings(JavaScriptObject value);
/**
* The attribute to use on menu items to look up the item title. Typing the first
letter of an item when the menu is open focuses that item. If unset, textContent
will be used.
*
* JavaScript Info:
* @property attrForItemTitle
* @type String
* @behavior PaperTabs
*/
@JsProperty String getAttrForItemTitle();
/**
* The attribute to use on menu items to look up the item title. Typing the first
letter of an item when the menu is open focuses that item. If unset, textContent
will be used.
*
* JavaScript Info:
* @property attrForItemTitle
* @type String
* @behavior PaperTabs
*/
@JsProperty void setAttrForItemTitle(String value);
/**
* Returns the currently focused item.
*
* JavaScript Info:
* @property focusedItem
* @type Object
* @behavior PaperTabs
*/
@JsProperty JavaScriptObject getFocusedItem();
/**
* Returns the currently focused item.
*
* JavaScript Info:
* @property focusedItem
* @type Object
* @behavior PaperTabs
*/
@JsProperty void setFocusedItem(JavaScriptObject value);
/**
*
*
* JavaScript Info:
* @method select
* @param {} value
* @behavior PaperTabs
*/
void select(JavaScriptObject value);
/**
*
*
* JavaScript Info:
* @property observers
* @type Array
* @behavior PaperTabs
*/
@JsProperty JsArray getObservers();
/**
*
*
* JavaScript Info:
* @property observers
* @type Array
* @behavior PaperTabs
*/
@JsProperty void setObservers(JsArray value);
/**
* If true, multiple selections are allowed.
*
* JavaScript Info:
* @property multi
* @type Boolean
* @behavior PaperTabs
*/
@JsProperty boolean getMulti();
/**
* If true, multiple selections are allowed.
*
* JavaScript Info:
* @property multi
* @type Boolean
* @behavior PaperTabs
*/
@JsProperty void setMulti(boolean value);
/**
*
*
* JavaScript Info:
* @method multiChanged
* @param {} multi
* @behavior PaperTabs
*/
void multiChanged(JavaScriptObject multi);
/**
* Returns an array of currently selected items.
*
* JavaScript Info:
* @property selectedItems
* @type Array
* @behavior PaperTabs
*/
@JsProperty JsArray getSelectedItems();
/**
* Returns an array of currently selected items.
*
* JavaScript Info:
* @property selectedItems
* @type Array
* @behavior PaperTabs
*/
@JsProperty void setSelectedItems(JsArray value);
/**
* Gets or sets the selected elements. This is used instead of selected when multi
is true.
*
* JavaScript Info:
* @property selectedValues
* @type Array
* @behavior PaperTabs
*/
@JsProperty JsArray getSelectedValues();
/**
* Gets or sets the selected elements. This is used instead of selected when multi
is true.
*
* JavaScript Info:
* @property selectedValues
* @type Array
* @behavior PaperTabs
*/
@JsProperty void setSelectedValues(JsArray value);
/**
* The event that fires from items when they are selected. Selectable
will listen for this event from items and update the selection state.
Set to empty string to listen to no events.
*
* JavaScript Info:
* @property activateEvent
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty String getActivateEvent();
/**
* The event that fires from items when they are selected. Selectable
will listen for this event from items and update the selection state.
Set to empty string to listen to no events.
*
* JavaScript Info:
* @property activateEvent
* @type string
* @behavior NeonAnimatedPages
*/
@JsProperty void setActivateEvent(String value);
/**
* 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 next item.
*
* JavaScript Info:
* @method selectNext
* @behavior NeonAnimatedPages
*/
void selectNext();
/**
* Selects the previous item.
*
* JavaScript Info:
* @method selectPrevious
* @behavior NeonAnimatedPages
*/
void selectPrevious();
/**
* 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);
/**
* Can be used to imperatively add a key binding to the implementing
element. This is the imperative equivalent of declaring a keybinding
in the keyBindings prototype property.
*
* JavaScript Info:
* @method addOwnKeyBinding
* @param {} eventString
* @param {} handlerName
* @behavior PaperTabs
*/
void addOwnKeyBinding(JavaScriptObject eventString, JavaScriptObject handlerName);
/**
* The HTMLElement that will be firing relevant KeyboardEvents.
*
* JavaScript Info:
* @property keyEventTarget
* @type Object
* @behavior PaperTabs
*/
@JsProperty JavaScriptObject getKeyEventTarget();
/**
* The HTMLElement that will be firing relevant KeyboardEvents.
*
* JavaScript Info:
* @property keyEventTarget
* @type Object
* @behavior PaperTabs
*/
@JsProperty void setKeyEventTarget(JavaScriptObject value);
/**
*
*
* JavaScript Info:
* @method keyboardEventMatchesKeys
* @param {} event
* @param {} eventString
* @behavior PaperTabs
*/
void keyboardEventMatchesKeys(JavaScriptObject event, JavaScriptObject eventString);
/**
* When called, will remove all imperatively-added key bindings.
*
* JavaScript Info:
* @method removeOwnKeyBindings
* @behavior PaperTabs
*/
void removeOwnKeyBindings();
/**
*
*
* JavaScript Info:
* @method registered
* @behavior PaperTabs
*/
void registered();
}