Package com.vaadin.client.ui.orderedlayout

Class Slot

  • All Implemented Interfaces:
    com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, HasErrorIndicatorElement, Iterable<com.google.gwt.user.client.ui.Widget>
    public class Slot
extends com.google.gwt.user.client.ui.SimplePanel
implements HasErrorIndicatorElement
    Represents a slot which contains the actual widget in the layout.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

        com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

      • Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

        com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String SLOT_CLASSNAME
      The default classname for this widget.

      • Fields inherited from class com.google.gwt.user.client.ui.UIObject

        DEBUG_ID_PREFIX

    • Constructor Detail

      • Slot

        public Slot()
        Constructs a slot. When using this constructor, the layout and widget must be set before any other operations are performed on the slot.
        Since:
        7.6

    • Method Detail

      • setLayout

        public void setLayout​(VAbstractOrderedLayout layout)
        Set the layout in which this slot is. This method must be called exactly once at slot construction time when using the default constructor. The method should normally only be called by VAbstractOrderedLayout.createSlot(Widget).
        Parameters:
        layout - the layout containing the slot
        Since:
        7.6

      • remove

        public boolean remove​(com.google.gwt.user.client.ui.Widget w)
        Specified by:
        remove in interface com.google.gwt.user.client.ui.HasWidgets
        Overrides:
        remove in class com.google.gwt.user.client.ui.SimplePanel

      • setWidget

        public void setWidget​(com.google.gwt.user.client.ui.Widget w)
        Specified by:
        setWidget in interface com.google.gwt.user.client.ui.HasOneWidget
        Overrides:
        setWidget in class com.google.gwt.user.client.ui.SimplePanel

      • getCaptionResizeListener

        public ElementResizeListener getCaptionResizeListener()
        Returns the caption resize listener for this slot if one has been set.
        Returns:
        the listener or null if not set

      • setCaptionResizeListener

        public void setCaptionResizeListener​(ElementResizeListener captionResizeListener)
        Sets the caption resize listener for this slot.
        Parameters:
        captionResizeListener - the listener to set, or null to remove a previously set listener

      • getWidgetResizeListener

        public ElementResizeListener getWidgetResizeListener()
        Returns the widget resize listener for this slot if one has been set.
        Returns:
        the listener or null if not set

      • setWidgetResizeListener

        public void setWidgetResizeListener​(ElementResizeListener widgetResizeListener)
        Sets the widget resize listener for this slot.
        Parameters:
        widgetResizeListener - the listener to set, or null to remove a previously set listener

      • getSpacingResizeListener

        public ElementResizeListener getSpacingResizeListener()
        Returns the spacing element resize listener for this slot if one has been set.
        Returns:
        the listener or null if not set

      • setSpacingResizeListener

        public void setSpacingResizeListener​(ElementResizeListener spacingResizeListener)
        Sets the spacing element resize listener for this slot.
        Parameters:
        spacingResizeListener - the listener to set, or null to remove a previously set listener

      • getAlignment

        public AlignmentInfo getAlignment()
        Returns the alignment for the slot.
        Returns:
        the alignment

      • setStyleNames

        protected void setStyleNames​(String... stylenames)
        Sets the style names for the slot containing the widget.
        Parameters:
        stylenames - The style names for the slot

      • setAlignment

        public void setAlignment​(AlignmentInfo alignment)
        Sets how the widget is aligned inside the slot.
        Parameters:
        alignment - The alignment inside the slot

      • setExpandRatio

        public void setExpandRatio​(double expandRatio)
        Set how the slot should be expanded relative to the other slots. 0 means that the slot should not participate in the division of space based on the expand ratios but instead be allocated space based on its natural size. Other values causes the slot to get a share of the otherwise unallocated space in proportion to the slot's expand ratio value.
        Parameters:
        expandRatio - The ratio of the space the slot should occupy

      • getExpandRatio

        public double getExpandRatio()
        Get the expand ratio for the slot. The expand ratio describes how the slot should be resized compared to other slots in the layout
        Returns:
        the expand ratio of the slot
        See Also:
        setExpandRatio(double)

      • setSpacing

        public void setSpacing​(boolean spacing)
        Set the spacing for the slot. The spacing determines if there should be empty space around the slot when the slot.
        Parameters:
        spacing - Should spacing be enabled

      • getSpacingElement

        public com.google.gwt.user.client.Element getSpacingElement()
        Get the element which is added to make the spacing.
        Returns:
        the spacing element

      • hasSpacing

        public boolean hasSpacing()
        Does the slot have spacing.
        Returns:
        true if the slot has spacing, false otherwise

      • getVerticalSpacing

        protected int getVerticalSpacing()
        Get the vertical amount in pixels of the spacing.
        Returns:
        the height of the spacing element or zero if this slot doesn't have spacing

      • getHorizontalSpacing

        protected int getHorizontalSpacing()
        Get the horizontal amount of pixels of the spacing.
        Returns:
        the width of the spacing element or zero if this slot doesn't have spacing

      • setCaptionPosition

        public void setCaptionPosition​(CaptionPosition captionPosition)
        Set the position of the caption relative to the slot.
        Parameters:
        captionPosition - The position of the caption

      • getCaptionPosition

        public CaptionPosition getCaptionPosition()
        Get the position of the caption relative to the slot.
        Returns:
        the position

      • setCaption

        @Deprecated
public void setCaption​(String captionText,
                       String iconUrl,
                       List<String> styles,
                       String error,
                       boolean showError,
                       boolean required,
                       boolean enabled)
        Deprecated.
        Use setCaption(String, Icon, List, String, boolean, boolean, boolean) instead
        Set the caption of the slot.
        Parameters:
        captionText - The text of the caption
        iconUrl - The icon URL, must already be run trough translateVaadinUri()
        styles - The style names
        error - The error message
        showError - Should the error message be shown
        required - Is the (field) required
        enabled - Is the component enabled

      • setCaption

        public void setCaption​(String captionText,
                       Icon icon,
                       List<String> styles,
                       String error,
                       boolean showError,
                       boolean required,
                       boolean enabled)
        Set the caption of the slot as text.
        Parameters:
        captionText - The text of the caption
        icon - The icon
        styles - The style names
        error - The error message
        showError - Should the error message be shown
        required - Is the (field) required
        enabled - Is the component enabled

      • setCaption

        public void setCaption​(String captionText,
                       Icon icon,
                       List<String> styles,
                       String error,
                       boolean showError,
                       boolean required,
                       boolean enabled,
                       boolean captionAsHtml)
        Set the caption of the slot.
        Parameters:
        captionText - The text of the caption
        icon - The icon
        styles - The style names
        error - The error message
        showError - Should the error message be shown
        required - Is the (field) required
        enabled - Is the component enabled
        captionAsHtml - true if the caption should be rendered as HTML, false otherwise

      • setCaption

        public void setCaption​(String captionText,
                       Icon icon,
                       List<String> styles,
                       String error,
                       ErrorLevel errorLevel,
                       boolean showError,
                       boolean required,
                       boolean enabled,
                       boolean captionAsHtml)
        Set the caption of the slot.
        Parameters:
        captionText - The text of the caption
        icon - The icon
        styles - The style names
        error - The error message
        errorLevel - The error level
        showError - Should the error message be shown
        required - Is the (field) required
        enabled - Is the component enabled
        captionAsHtml - true if the caption should be rendered as HTML, false otherwise
        Since:
        8.2

      • hasCaption

        public boolean hasCaption()
        Does the slot have a caption.
        Returns:
        true if the slot has a caption, false otherwise

      • getCaptionElement

        public com.google.gwt.user.client.Element getCaptionElement()
        Get the slots caption element.
        Returns:
        the caption element or null if there is no caption

      • setRelativeWidth

        public void setRelativeWidth​(boolean relativeWidth)
        Set if the slot has a relative width.
        Parameters:
        relativeWidth - True if slot uses relative width, false if the slot has a static width

      • hasRelativeWidth

        public boolean hasRelativeWidth()
        Returns whether the slot's width is relative.
        Returns:
        true if the slot uses relative width, false if the slot has a static width

      • setRelativeHeight

        public void setRelativeHeight​(boolean relativeHeight)
        Set if the slot has a relative height.
        Parameters:
        relativeHeight - True if the slot uses a relative height, false if the slot has a static height

      • hasRelativeHeight

        public boolean hasRelativeHeight()
        Returns whether the slot's height is relative.
        Returns:
        true if the slot uses relative height, false if the slot has a static height

      • onBrowserEvent

        public void onBrowserEvent​(com.google.gwt.user.client.Event event)
        Specified by:
        onBrowserEvent in interface com.google.gwt.user.client.EventListener
        Overrides:
        onBrowserEvent in class com.google.gwt.user.client.ui.Widget

      • getContainerElement

        protected com.google.gwt.user.client.Element getContainerElement()
        Overrides:
        getContainerElement in class com.google.gwt.user.client.ui.SimplePanel

      • onDetach

        protected void onDetach()
        Overrides:
        onDetach in class com.google.gwt.user.client.ui.Widget

      • onAttach

        protected void onAttach()
        Overrides:
        onAttach in class com.google.gwt.user.client.ui.Widget

      • isRelativeInDirection

        public boolean isRelativeInDirection​(boolean vertical)
        Returns whether this slot has relative size in the indicated direction.
        Parameters:
        vertical - true if the height should be checked, false if the width should be checked
        Returns:
        true if the slot's indicated dimension is relative, false otherwise