com.vaadin.polymer.iron.widget.IronDropdown Maven / Gradle / Ivy
/*
* This code was generated with Vaadin Web Component GWT API Generator,
* from iron-dropdown project by The Polymer Authors
* that is licensed with http://polymer.github.io/LICENSE.txt license.
*/
package com.vaadin.polymer.iron.widget;
import com.vaadin.polymer.iron.*;
import com.vaadin.polymer.iron.widget.event.IronOverlayCanceledEvent;
import com.vaadin.polymer.iron.widget.event.IronOverlayCanceledEventHandler;
import com.vaadin.polymer.iron.widget.event.IronOverlayClosedEvent;
import com.vaadin.polymer.iron.widget.event.IronOverlayClosedEventHandler;
import com.vaadin.polymer.iron.widget.event.IronOverlayOpenedEvent;
import com.vaadin.polymer.iron.widget.event.IronOverlayOpenedEventHandler;
import com.vaadin.polymer.*;
import com.vaadin.polymer.elemental.*;
import com.vaadin.polymer.PolymerWidget;
import com.google.gwt.core.client.JsArray;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.core.client.JavaScriptObject;
/**
* <iron-dropdown> is a generalized element that is useful when you have
hidden content (.dropdown-content) that is revealed due to some change in
state that should cause it to do so.
* Note that this is a low-level element intended to be used as part of other
composite elements that cause dropdowns to be revealed.
* Examples of elements that might be implemented using an iron-dropdown
include comboboxes, menubuttons, selects. The list goes on.
* The <iron-dropdown> element exposes attributes that allow the position
of the .dropdown-content relative to the .dropdown-trigger to be
configured.
* <iron-dropdown horizontal-align="right" vertical-align="top">
* <div class="dropdown-content">Hello!</div>
* </iron-dropdown>
*
*
*
In the above example, the <div> with class .dropdown-content will be
hidden until the dropdown element has opened set to true, or when the open
method is called on the element.
*/
public class IronDropdown extends PolymerWidget {
/**
* Default Constructor.
*/
public IronDropdown() {
this("");
}
/**
* Constructor used by UIBinder to create widgets with content.
*/
public IronDropdown(String html) {
super(IronDropdownElement.TAG, IronDropdownElement.SRC, html);
}
/**
* Gets a handle to the Polymer object's underlying DOM element.
*/
public IronDropdownElement getPolymerElement() {
return (IronDropdownElement) getElement();
}
/**
* Set to true to auto-fit on attach.
*
* JavaScript Info:
* @property autoFitOnAttach
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getAutoFitOnAttach() {
return getPolymerElement().getAutoFitOnAttach();
}
/**
* Set to true to auto-fit on attach.
*
* JavaScript Info:
* @property autoFitOnAttach
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setAutoFitOnAttach(boolean value) {
getPolymerElement().setAutoFitOnAttach(value);
}
/**
* The backdrop element.
*
* JavaScript Info:
* @property backdropElement
* @type Element
* @behavior VaadinContextMenuOverlay
*/
public Element getBackdropElement() {
return getPolymerElement().getBackdropElement();
}
/**
* The backdrop element.
*
* JavaScript Info:
* @property backdropElement
* @type Element
* @behavior VaadinContextMenuOverlay
*/
public void setBackdropElement(Element value) {
getPolymerElement().setBackdropElement(value);
}
/**
* A pixel value that will be added to the position calculated for the
given horizontalAlign, in the direction of alignment. You can think
of it as increasing or decreasing the distance to the side of the
screen given by horizontalAlign.
* If horizontalAlign is “left”, this offset will increase or decrease
the distance to the left side of the screen: a negative offset will
move the dropdown to the left; a positive one, to the right.
* Conversely if horizontalAlign is “right”, this offset will increase
or decrease the distance to the right side of the screen: a negative
offset will move the dropdown to the right; a positive one, to the left.
*
* JavaScript Info:
* @property horizontalOffset
* @type Number
* @behavior VaadinContextMenuOverlay
*/
public double getHorizontalOffset() {
return getPolymerElement().getHorizontalOffset();
}
/**
* A pixel value that will be added to the position calculated for the
given horizontalAlign, in the direction of alignment. You can think
of it as increasing or decreasing the distance to the side of the
screen given by horizontalAlign.
* If horizontalAlign is “left”, this offset will increase or decrease
the distance to the left side of the screen: a negative offset will
move the dropdown to the left; a positive one, to the right.
* Conversely if horizontalAlign is “right”, this offset will increase
or decrease the distance to the right side of the screen: a negative
offset will move the dropdown to the right; a positive one, to the left.
*
* JavaScript Info:
* @property horizontalOffset
* @type Number
* @behavior VaadinContextMenuOverlay
*/
public void setHorizontalOffset(double value) {
getPolymerElement().setHorizontalOffset(value);
}
/**
* A pixel value that will be added to the position calculated for the
given verticalAlign, in the direction of alignment. You can think
of it as increasing or decreasing the distance to the side of the
screen given by verticalAlign.
* If verticalAlign is “top”, this offset will increase or decrease
the distance to the top side of the screen: a negative offset will
move the dropdown upwards; a positive one, downwards.
* Conversely if verticalAlign is “bottom”, this offset will increase
or decrease the distance to the bottom side of the screen: a negative
offset will move the dropdown downwards; a positive one, upwards.
*
* JavaScript Info:
* @property verticalOffset
* @type Number
* @behavior VaadinContextMenuOverlay
*/
public double getVerticalOffset() {
return getPolymerElement().getVerticalOffset();
}
/**
* A pixel value that will be added to the position calculated for the
given verticalAlign, in the direction of alignment. You can think
of it as increasing or decreasing the distance to the side of the
screen given by verticalAlign.
* If verticalAlign is “top”, this offset will increase or decrease
the distance to the top side of the screen: a negative offset will
move the dropdown upwards; a positive one, downwards.
* Conversely if verticalAlign is “bottom”, this offset will increase
or decrease the distance to the bottom side of the screen: a negative
offset will move the dropdown downwards; a positive one, upwards.
*
* JavaScript Info:
* @property verticalOffset
* @type Number
* @behavior VaadinContextMenuOverlay
*/
public void setVerticalOffset(double value) {
getPolymerElement().setVerticalOffset(value);
}
/**
* The EventTarget that will be firing relevant KeyboardEvents. Set it to
null to disable the listeners.
*
* JavaScript Info:
* @property keyEventTarget
* @type ?EventTarget
* @behavior VaadinDatePicker
*/
public JavaScriptObject getKeyEventTarget() {
return getPolymerElement().getKeyEventTarget();
}
/**
* The EventTarget that will be firing relevant KeyboardEvents. Set it to
null to disable the listeners.
*
* JavaScript Info:
* @property keyEventTarget
* @type ?EventTarget
* @behavior VaadinDatePicker
*/
public void setKeyEventTarget(JavaScriptObject value) {
getPolymerElement().setKeyEventTarget(value);
}
/**
* Contains the reason(s) this overlay was last closed (see iron-overlay-closed).
IronOverlayBehavior provides the canceled reason; implementers of the
behavior can provide other reasons in addition to canceled.
*
* JavaScript Info:
* @property closingReason
* @type Object
* @behavior VaadinContextMenuOverlay
*/
public JavaScriptObject getClosingReason() {
return getPolymerElement().getClosingReason();
}
/**
* Contains the reason(s) this overlay was last closed (see iron-overlay-closed).
IronOverlayBehavior provides the canceled reason; implementers of the
behavior can provide other reasons in addition to canceled.
*
* JavaScript Info:
* @property closingReason
* @type Object
* @behavior VaadinContextMenuOverlay
*/
public void setClosingReason(JavaScriptObject value) {
getPolymerElement().setClosingReason(value);
}
/**
* Animation configuration. See README for more info.
*
* JavaScript Info:
* @property animationConfig
* @type Object
* @behavior PaperTooltip
*/
public JavaScriptObject getAnimationConfig() {
return getPolymerElement().getAnimationConfig();
}
/**
* Animation configuration. See README for more info.
*
* JavaScript Info:
* @property animationConfig
* @type Object
* @behavior PaperTooltip
*/
public void setAnimationConfig(JavaScriptObject value) {
getPolymerElement().setAnimationConfig(value);
}
/**
* If provided, this will be the element that will be focused when
the dropdown opens.
*
* JavaScript Info:
* @property focusTarget
* @type Object
*
*/
public JavaScriptObject getFocusTarget() {
return getPolymerElement().getFocusTarget();
}
/**
* If provided, this will be the element that will be focused when
the dropdown opens.
*
* JavaScript Info:
* @property focusTarget
* @type Object
*
*/
public void setFocusTarget(JavaScriptObject value) {
getPolymerElement().setFocusTarget(value);
}
/**
* An animation config. If provided, this will be used to animate the
closing of the dropdown. Pass an Array for multiple animations.
See neon-animation documentation for more animation configuration
details.
*
* JavaScript Info:
* @property closeAnimationConfig
* @type Object
*
*/
public JavaScriptObject getCloseAnimationConfig() {
return getPolymerElement().getCloseAnimationConfig();
}
/**
* An animation config. If provided, this will be used to animate the
closing of the dropdown. Pass an Array for multiple animations.
See neon-animation documentation for more animation configuration
details.
*
* JavaScript Info:
* @property closeAnimationConfig
* @type Object
*
*/
public void setCloseAnimationConfig(JavaScriptObject value) {
getPolymerElement().setCloseAnimationConfig(value);
}
/**
* An animation config. If provided, this will be used to animate the
opening of the dropdown. Pass an Array for multiple animations.
See neon-animation documentation for more animation configuration
details.
*
* JavaScript Info:
* @property openAnimationConfig
* @type Object
*
*/
public JavaScriptObject getOpenAnimationConfig() {
return getPolymerElement().getOpenAnimationConfig();
}
/**
* An animation config. If provided, this will be used to animate the
opening of the dropdown. Pass an Array for multiple animations.
See neon-animation documentation for more animation configuration
details.
*
* JavaScript Info:
* @property openAnimationConfig
* @type Object
*
*/
public void setOpenAnimationConfig(JavaScriptObject value) {
getPolymerElement().setOpenAnimationConfig(value);
}
/**
* The element that should be used to position the element. If not set, it will
default to the parent node.
*
* JavaScript Info:
* @property positionTarget
* @type !Element
* @behavior VaadinContextMenuOverlay
*/
public JavaScriptObject getPositionTarget() {
return getPolymerElement().getPositionTarget();
}
/**
* The element that should be used to position the element. If not set, it will
default to the parent node.
*
* JavaScript Info:
* @property positionTarget
* @type !Element
* @behavior VaadinContextMenuOverlay
*/
public void setPositionTarget(JavaScriptObject value) {
getPolymerElement().setPositionTarget(value);
}
/**
* The element that will receive a max-height/width. By default it is the same as this,
but it can be set to a child element. This is useful, for example, for implementing a
scrolling region inside the element.
*
* JavaScript Info:
* @property sizingTarget
* @type !Element
* @behavior VaadinContextMenuOverlay
*/
public JavaScriptObject getSizingTarget() {
return getPolymerElement().getSizingTarget();
}
/**
* The element that will receive a max-height/width. By default it is the same as this,
but it can be set to a child element. This is useful, for example, for implementing a
scrolling region inside the element.
*
* JavaScript Info:
* @property sizingTarget
* @type !Element
* @behavior VaadinContextMenuOverlay
*/
public void setSizingTarget(JavaScriptObject value) {
getPolymerElement().setSizingTarget(value);
}
/**
* To be used to express what combination of keys will trigger the relative
callback. e.g. keyBindings: { 'esc': '_onEscPressed'}
*
* JavaScript Info:
* @property keyBindings
* @type !Object
* @behavior VaadinDatePicker
*/
public JavaScriptObject getKeyBindings() {
return getPolymerElement().getKeyBindings();
}
/**
* To be used to express what combination of keys will trigger the relative
callback. e.g. keyBindings: { 'esc': '_onEscPressed'}
*
* JavaScript Info:
* @property keyBindings
* @type !Object
* @behavior VaadinDatePicker
*/
public void setKeyBindings(JavaScriptObject value) {
getPolymerElement().setKeyBindings(value);
}
/**
* The element to fit this into.
*
* JavaScript Info:
* @property fitInto
* @type Object
* @behavior VaadinContextMenuOverlay
*/
public JavaScriptObject getFitInto() {
return getPolymerElement().getFitInto();
}
/**
* The element to fit this into.
*
* JavaScript Info:
* @property fitInto
* @type Object
* @behavior VaadinContextMenuOverlay
*/
public void setFitInto(JavaScriptObject value) {
getPolymerElement().setFitInto(value);
}
/**
* Set to true to display a backdrop behind the overlay. It traps the focus
within the light DOM of the overlay.
*
* JavaScript Info:
* @property withBackdrop
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getWithBackdrop() {
return getPolymerElement().getWithBackdrop();
}
/**
* Set to true to display a backdrop behind the overlay. It traps the focus
within the light DOM of the overlay.
*
* JavaScript Info:
* @property withBackdrop
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setWithBackdrop(boolean value) {
getPolymerElement().setWithBackdrop(value);
}
/**
* By default, the dropdown will constrain scrolling on the page
to itself when opened.
Set to true in order to prevent scroll from being constrained
to the dropdown when it opens.
*
* JavaScript Info:
* @property allowOutsideScroll
* @type Boolean
*
*/
public boolean getAllowOutsideScroll() {
return getPolymerElement().getAllowOutsideScroll();
}
/**
* By default, the dropdown will constrain scrolling on the page
to itself when opened.
Set to true in order to prevent scroll from being constrained
to the dropdown when it opens.
*
* JavaScript Info:
* @property allowOutsideScroll
* @type Boolean
*
*/
public void setAllowOutsideScroll(boolean value) {
getPolymerElement().setAllowOutsideScroll(value);
}
/**
* Set to true to disable animations when opening and closing the
dropdown.
*
* JavaScript Info:
* @property noAnimations
* @type Boolean
*
*/
public boolean getNoAnimations() {
return getPolymerElement().getNoAnimations();
}
/**
* Set to true to disable animations when opening and closing the
dropdown.
*
* JavaScript Info:
* @property noAnimations
* @type Boolean
*
*/
public void setNoAnimations(boolean value) {
getPolymerElement().setNoAnimations(value);
}
/**
* If true, it will use horizontalAlign and verticalAlign values as preferred alignment
and if there’s not enough space, it will pick the values which minimize the cropping.
*
* JavaScript Info:
* @property dynamicAlign
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getDynamicAlign() {
return getPolymerElement().getDynamicAlign();
}
/**
* If true, it will use horizontalAlign and verticalAlign values as preferred alignment
and if there’s not enough space, it will pick the values which minimize the cropping.
*
* JavaScript Info:
* @property dynamicAlign
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setDynamicAlign(boolean value) {
getPolymerElement().setDynamicAlign(value);
}
/**
* If true, this property will cause the implementing element to
automatically stop propagation on any handled KeyboardEvents.
*
* JavaScript Info:
* @property stopKeyboardEventPropagation
* @type Boolean
* @behavior VaadinDatePicker
*/
public boolean getStopKeyboardEventPropagation() {
return getPolymerElement().getStopKeyboardEventPropagation();
}
/**
* If true, this property will cause the implementing element to
automatically stop propagation on any handled KeyboardEvents.
*
* JavaScript Info:
* @property stopKeyboardEventPropagation
* @type Boolean
* @behavior VaadinDatePicker
*/
public void setStopKeyboardEventPropagation(boolean value) {
getPolymerElement().setStopKeyboardEventPropagation(value);
}
/**
* Set to true to keep overlay always on top.
*
* JavaScript Info:
* @property alwaysOnTop
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getAlwaysOnTop() {
return getPolymerElement().getAlwaysOnTop();
}
/**
* Set to true to keep overlay always on top.
*
* JavaScript Info:
* @property alwaysOnTop
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setAlwaysOnTop(boolean value) {
getPolymerElement().setAlwaysOnTop(value);
}
/**
* If true, the user cannot interact with this element.
*
* JavaScript Info:
* @property disabled
* @type Boolean
* @behavior PaperTab
*/
public boolean getDisabled() {
return getPolymerElement().getDisabled();
}
/**
* If true, the user cannot interact with this element.
*
* JavaScript Info:
* @property disabled
* @type Boolean
* @behavior PaperTab
*/
public void setDisabled(boolean value) {
getPolymerElement().setDisabled(value);
}
/**
* Will position the element around the positionTarget without overlapping it.
*
* JavaScript Info:
* @property noOverlap
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getNoOverlap() {
return getPolymerElement().getNoOverlap();
}
/**
* Will position the element around the positionTarget without overlapping it.
*
* JavaScript Info:
* @property noOverlap
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setNoOverlap(boolean value) {
getPolymerElement().setNoOverlap(value);
}
/**
* True if the overlay was canceled when it was last closed.
*
* JavaScript Info:
* @property canceled
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getCanceled() {
return getPolymerElement().getCanceled();
}
/**
* True if the overlay was canceled when it was last closed.
*
* JavaScript Info:
* @property canceled
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setCanceled(boolean value) {
getPolymerElement().setCanceled(value);
}
/**
* If true, the element currently has focus.
*
* JavaScript Info:
* @property focused
* @type Boolean
* @behavior PaperTab
*/
public boolean getFocused() {
return getPolymerElement().getFocused();
}
/**
* If true, the element currently has focus.
*
* JavaScript Info:
* @property focused
* @type Boolean
* @behavior PaperTab
*/
public void setFocused(boolean value) {
getPolymerElement().setFocused(value);
}
/**
* Set to true to disable auto-focusing the overlay or child nodes with
the autofocus attribute` when the overlay is opened.
*
* JavaScript Info:
* @property noAutoFocus
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getNoAutoFocus() {
return getPolymerElement().getNoAutoFocus();
}
/**
* Set to true to disable auto-focusing the overlay or child nodes with
the autofocus attribute` when the overlay is opened.
*
* JavaScript Info:
* @property noAutoFocus
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setNoAutoFocus(boolean value) {
getPolymerElement().setNoAutoFocus(value);
}
/**
* Set to true to disable canceling the overlay with the ESC key.
*
* JavaScript Info:
* @property noCancelOnEscKey
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getNoCancelOnEscKey() {
return getPolymerElement().getNoCancelOnEscKey();
}
/**
* Set to true to disable canceling the overlay with the ESC key.
*
* JavaScript Info:
* @property noCancelOnEscKey
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setNoCancelOnEscKey(boolean value) {
getPolymerElement().setNoCancelOnEscKey(value);
}
/**
* Set to true to disable canceling the overlay by clicking outside it.
*
* JavaScript Info:
* @property noCancelOnOutsideClick
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getNoCancelOnOutsideClick() {
return getPolymerElement().getNoCancelOnOutsideClick();
}
/**
* Set to true to disable canceling the overlay by clicking outside it.
*
* JavaScript Info:
* @property noCancelOnOutsideClick
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setNoCancelOnOutsideClick(boolean value) {
getPolymerElement().setNoCancelOnOutsideClick(value);
}
/**
* True if the overlay is currently displayed.
*
* JavaScript Info:
* @property opened
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getOpened() {
return getPolymerElement().getOpened();
}
/**
* True if the overlay is currently displayed.
*
* JavaScript Info:
* @property opened
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setOpened(boolean value) {
getPolymerElement().setOpened(value);
}
/**
* Set to true to enable restoring of focus when overlay is closed.
*
* JavaScript Info:
* @property restoreFocusOnClose
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public boolean getRestoreFocusOnClose() {
return getPolymerElement().getRestoreFocusOnClose();
}
/**
* Set to true to enable restoring of focus when overlay is closed.
*
* JavaScript Info:
* @property restoreFocusOnClose
* @type Boolean
* @behavior VaadinContextMenuOverlay
*/
public void setRestoreFocusOnClose(boolean value) {
getPolymerElement().setRestoreFocusOnClose(value);
}
/**
* The orientation against which to align the element vertically
relative to the positionTarget. Possible values are “top”, “bottom”, “auto”.
*
* JavaScript Info:
* @property verticalAlign
* @type String
* @behavior VaadinContextMenuOverlay
*/
public String getVerticalAlign() {
return getPolymerElement().getVerticalAlign();
}
/**
* The orientation against which to align the element vertically
relative to the positionTarget. Possible values are “top”, “bottom”, “auto”.
*
* JavaScript Info:
* @property verticalAlign
* @type String
* @behavior VaadinContextMenuOverlay
*/
public void setVerticalAlign(String value) {
getPolymerElement().setVerticalAlign(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 PaperTooltip
*/
public String getEntryAnimation() {
return getPolymerElement().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 PaperTooltip
*/
public void setEntryAnimation(String value) {
getPolymerElement().setEntryAnimation(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 PaperTooltip
*/
public String getExitAnimation() {
return getPolymerElement().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 PaperTooltip
*/
public void setExitAnimation(String value) {
getPolymerElement().setExitAnimation(value);
}
/**
* The orientation against which to align the dropdown content
horizontally relative to the dropdown trigger.
Overridden from Polymer.IronFitBehavior.
*
* JavaScript Info:
* @property horizontalAlign
* @type String
*
*/
public String getHorizontalAlign() {
return getPolymerElement().getHorizontalAlign();
}
/**
* The orientation against which to align the dropdown content
horizontally relative to the dropdown trigger.
Overridden from Polymer.IronFitBehavior.
*
* JavaScript Info:
* @property horizontalAlign
* @type String
*
*/
public void setHorizontalAlign(String value) {
getPolymerElement().setHorizontalAlign(value);
}
// Needed in UIBinder
/**
* The backdrop element.
*
* JavaScript Info:
* @attribute backdrop-element
* @behavior VaadinContextMenuOverlay
*/
public void setBackdropElement(String value) {
Polymer.property(this.getPolymerElement(), "backdropElement", value);
}
// Needed in UIBinder
/**
* A pixel value that will be added to the position calculated for the
given verticalAlign, in the direction of alignment. You can think
of it as increasing or decreasing the distance to the side of the
screen given by verticalAlign.
* If verticalAlign is “top”, this offset will increase or decrease
the distance to the top side of the screen: a negative offset will
move the dropdown upwards; a positive one, downwards.
* Conversely if verticalAlign is “bottom”, this offset will increase
or decrease the distance to the bottom side of the screen: a negative
offset will move the dropdown downwards; a positive one, upwards.
*
* JavaScript Info:
* @attribute vertical-offset
* @behavior VaadinContextMenuOverlay
*/
public void setVerticalOffset(String value) {
Polymer.property(this.getPolymerElement(), "verticalOffset", value);
}
// Needed in UIBinder
/**
* A pixel value that will be added to the position calculated for the
given horizontalAlign, in the direction of alignment. You can think
of it as increasing or decreasing the distance to the side of the
screen given by horizontalAlign.
* If horizontalAlign is “left”, this offset will increase or decrease
the distance to the left side of the screen: a negative offset will
move the dropdown to the left; a positive one, to the right.
* Conversely if horizontalAlign is “right”, this offset will increase
or decrease the distance to the right side of the screen: a negative
offset will move the dropdown to the right; a positive one, to the left.
*
* JavaScript Info:
* @attribute horizontal-offset
* @behavior VaadinContextMenuOverlay
*/
public void setHorizontalOffset(String value) {
Polymer.property(this.getPolymerElement(), "horizontalOffset", value);
}
// Needed in UIBinder
/**
* Contains the reason(s) this overlay was last closed (see iron-overlay-closed).
IronOverlayBehavior provides the canceled reason; implementers of the
behavior can provide other reasons in addition to canceled.
*
* JavaScript Info:
* @attribute closing-reason
* @behavior VaadinContextMenuOverlay
*/
public void setClosingReason(String value) {
Polymer.property(this.getPolymerElement(), "closingReason", value);
}
// Needed in UIBinder
/**
* Animation configuration. See README for more info.
*
* JavaScript Info:
* @attribute animation-config
* @behavior PaperTooltip
*/
public void setAnimationConfig(String value) {
Polymer.property(this.getPolymerElement(), "animationConfig", value);
}
// Needed in UIBinder
/**
* If provided, this will be the element that will be focused when
the dropdown opens.
*
* JavaScript Info:
* @attribute focus-target
*
*/
public void setFocusTarget(String value) {
Polymer.property(this.getPolymerElement(), "focusTarget", value);
}
// Needed in UIBinder
/**
* An animation config. If provided, this will be used to animate the
closing of the dropdown. Pass an Array for multiple animations.
See neon-animation documentation for more animation configuration
details.
*
* JavaScript Info:
* @attribute close-animation-config
*
*/
public void setCloseAnimationConfig(String value) {
Polymer.property(this.getPolymerElement(), "closeAnimationConfig", value);
}
// Needed in UIBinder
/**
* The element that should be used to position the element. If not set, it will
default to the parent node.
*
* JavaScript Info:
* @attribute position-target
* @behavior VaadinContextMenuOverlay
*/
public void setPositionTarget(String value) {
Polymer.property(this.getPolymerElement(), "positionTarget", value);
}
// Needed in UIBinder
/**
* The element that will receive a max-height/width. By default it is the same as this,
but it can be set to a child element. This is useful, for example, for implementing a
scrolling region inside the element.
*
* JavaScript Info:
* @attribute sizing-target
* @behavior VaadinContextMenuOverlay
*/
public void setSizingTarget(String value) {
Polymer.property(this.getPolymerElement(), "sizingTarget", value);
}
// Needed in UIBinder
/**
* To be used to express what combination of keys will trigger the relative
callback. e.g. keyBindings: { 'esc': '_onEscPressed'}
*
* JavaScript Info:
* @attribute key-bindings
* @behavior VaadinDatePicker
*/
public void setKeyBindings(String value) {
Polymer.property(this.getPolymerElement(), "keyBindings", value);
}
// Needed in UIBinder
/**
* The element to fit this into.
*
* JavaScript Info:
* @attribute fit-into
* @behavior VaadinContextMenuOverlay
*/
public void setFitInto(String value) {
Polymer.property(this.getPolymerElement(), "fitInto", value);
}
// Needed in UIBinder
/**
* The EventTarget that will be firing relevant KeyboardEvents. Set it to
null to disable the listeners.
*
* JavaScript Info:
* @attribute key-event-target
* @behavior VaadinDatePicker
*/
public void setKeyEventTarget(String value) {
Polymer.property(this.getPolymerElement(), "keyEventTarget", value);
}
// Needed in UIBinder
/**
* An animation config. If provided, this will be used to animate the
opening of the dropdown. Pass an Array for multiple animations.
See neon-animation documentation for more animation configuration
details.
*
* JavaScript Info:
* @attribute open-animation-config
*
*/
public void setOpenAnimationConfig(String value) {
Polymer.property(this.getPolymerElement(), "openAnimationConfig", 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 VaadinDatePicker
*
*/
public void addOwnKeyBinding(Object eventString, Object handlerName) {
getPolymerElement().addOwnKeyBinding(eventString, handlerName);
}
/**
* 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 VaadinSplitLayout
*
*/
public void assignParentResizable(Object parentResizable) {
getPolymerElement().assignParentResizable(parentResizable);
}
/**
* 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 VaadinSplitLayout
*
*/
public void stopResizeNotificationsFor(Object target) {
getPolymerElement().stopResizeNotificationsFor(target);
}
/**
* Positions and fits the element into the fitInto element.
*
* JavaScript Info:
* @method fit
* @behavior VaadinContextMenuOverlay
*
*/
public void fit() {
getPolymerElement().fit();
}
/**
* Close the overlay.
*
* JavaScript Info:
* @method close
* @behavior VaadinContextMenuOverlay
*
*/
public void close() {
getPolymerElement().close();
}
/**
* Positions the element according to horizontalAlign, verticalAlign.
*
* JavaScript Info:
* @method position
* @behavior VaadinContextMenuOverlay
*
*/
public void position() {
getPolymerElement().position();
}
/**
* Invalidates the cached tabbable nodes. To be called when any of the focusable
content changes (e.g. a button is disabled).
*
* JavaScript Info:
* @method invalidateTabbables
* @behavior VaadinContextMenuOverlay
*
*/
public void invalidateTabbables() {
getPolymerElement().invalidateTabbables();
}
/**
* Equivalent to calling resetFit() and fit(). Useful to call this after
the element or the fitInto element has been resized, or if any of the
positioning properties (e.g. horizontalAlign, verticalAlign) is updated.
It preserves the scroll position of the sizingTarget.
*
* JavaScript Info:
* @method refit
* @behavior VaadinContextMenuOverlay
*
*/
public void refit() {
getPolymerElement().refit();
}
/**
* Resets the target element’s position and size constraints, and clear
the memoized data.
*
* JavaScript Info:
* @method resetFit
* @behavior VaadinContextMenuOverlay
*
*/
public void resetFit() {
getPolymerElement().resetFit();
}
/**
* Cancels the currently running animations.
*
* JavaScript Info:
* @method cancelAnimation
* @behavior PaperTooltip
*
*/
public void cancelAnimation() {
getPolymerElement().cancelAnimation();
}
/**
* Can be called to manually notify a resizable and its descendant
resizables of a resize change.
*
* JavaScript Info:
* @method notifyResize
* @behavior VaadinSplitLayout
*
*/
public void notifyResize() {
getPolymerElement().notifyResize();
}
/**
* When called, will remove all imperatively-added key bindings.
*
* JavaScript Info:
* @method removeOwnKeyBindings
* @behavior VaadinDatePicker
*
*/
public void removeOwnKeyBindings() {
getPolymerElement().removeOwnKeyBindings();
}
/**
* Open the overlay.
*
* JavaScript Info:
* @method open
* @behavior VaadinContextMenuOverlay
*
*/
public void open() {
getPolymerElement().open();
}
/**
* Toggle the opened state of the overlay.
*
* JavaScript Info:
* @method toggle
* @behavior VaadinContextMenuOverlay
*
*/
public void toggle() {
getPolymerElement().toggle();
}
/**
* Centers horizontally and vertically if not already positioned. This also sets
position:fixed.
*
* JavaScript Info:
* @method center
* @behavior VaadinContextMenuOverlay
*
*/
public void center() {
getPolymerElement().center();
}
/**
* Constrains the size of the element to fitInto by setting max-height
and/or max-width.
*
* JavaScript Info:
* @method constrain
* @behavior VaadinContextMenuOverlay
*
*/
public void constrain() {
getPolymerElement().constrain();
}
/**
* Returns true if a keyboard event matches eventString.
*
* JavaScript Info:
* @method keyboardEventMatchesKeys
* @param {KeyboardEvent} event
* @param {string} eventString
* @behavior VaadinDatePicker
* @return {boolean}
*/
public boolean keyboardEventMatchesKeys(JavaScriptObject event, String eventString) {
return getPolymerElement().keyboardEventMatchesKeys(event, eventString);
}
/**
* 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 VaadinSplitLayout
* @return {boolean}
*/
public boolean resizerShouldNotify(JavaScriptObject element) {
return getPolymerElement().resizerShouldNotify(element);
}
/**
* Cancels the overlay.
*
* JavaScript Info:
* @method cancel
* @param {Event=} event
* @behavior VaadinContextMenuOverlay
*
*/
public void cancel(JavaScriptObject event) {
getPolymerElement().cancel(event);
}
/**
* Plays an animation with an optional type.
*
* JavaScript Info:
* @method playAnimation
* @param {string=} type
* @param {!Object=} cookie
* @behavior PaperTooltip
*
*/
public void playAnimation(String type, JavaScriptObject cookie) {
getPolymerElement().playAnimation(type, cookie);
}
/**
* Fired when the overlay is canceled, but before it is closed.
*
* JavaScript Info:
* @event iron-overlay-canceled
*/
public HandlerRegistration addIronOverlayCanceledHandler(IronOverlayCanceledEventHandler handler) {
return addDomHandler(handler, IronOverlayCanceledEvent.TYPE);
}
/**
* Fired after the overlay closes.
*
* JavaScript Info:
* @event iron-overlay-closed
*/
public HandlerRegistration addIronOverlayClosedHandler(IronOverlayClosedEventHandler handler) {
return addDomHandler(handler, IronOverlayClosedEvent.TYPE);
}
/**
* Fired after the overlay opens.
*
* JavaScript Info:
* @event iron-overlay-opened
*/
public HandlerRegistration addIronOverlayOpenedHandler(IronOverlayOpenedEventHandler handler) {
return addDomHandler(handler, IronOverlayOpenedEvent.TYPE);
}
}