Package eu.webtoolkit.jwt

Class WMenuItem

  • public class WMenuItem
extends WContainerWidget
    A single item in a menu.

    Since JWt 3.3.0, this item is now a proper widget, which renders a single item in a menu.

    An optional contents item can be associated with a menu item, which is inserted and shown in the widget stack of the menu to which this menu item belongs.

    CSS

    A menu item renders as a >li&;lt with additional markup/style classes provided by the theme. Unless you use the bootstrap theme, you will need to provide appropriate CSS.

    • Constructor Detail

      • WMenuItem

        public WMenuItem​(java.lang.CharSequence text,
                 WWidget contents,
                 ContentLoading policy)
        Creates a new item with given label.

        The optional contents is a widget that will be shown in the WMenu contents stack when the item is selected. For this widget, a load policy specifies whether the contents widgets is transmitted only when it the item is activated for the first time (LazyLoading) or transmitted prior to first rendering.

        If the menu supports internal path navigation, then a default getPathComponent() will be derived from the label, and can be customized using setPathComponent().

      • WMenuItem

        public WMenuItem​(java.lang.String iconPath,
                 java.lang.CharSequence text,
                 WWidget contents,
                 ContentLoading policy)

      • WMenuItem

        public WMenuItem​(java.lang.String iconPath,
                 java.lang.CharSequence text)

      • WMenuItem

        public WMenuItem​(java.lang.String iconPath,
                 java.lang.CharSequence text,
                 WWidget contents)

    • Method Detail

      • setText

        public void setText​(java.lang.CharSequence text)
        Sets the text for this item.

        Unless a custom path component was defined, the getPathComponent() is also updated based on the new text.

        The item widget is updated using updateItemWidget().

        See Also:
        setPathComponent(String path)

      • setIcon

        public void setIcon​(java.lang.String path)
        Sets the item icon path.

        The icon should have a width of 16 pixels.

        See Also:
        setText(CharSequence text)

      • getIcon

        public java.lang.String getIcon()
        Returns the item icon path.

        See Also:
        setIcon(String path)

      • setCheckable

        public void setCheckable​(boolean checkable)
        Sets if the item is checkable.

        When an item is checkable, a checkbox is displayed to the left of the item text (instead of an icon).

        See Also:
        setChecked(boolean checked), isChecked()

      • getPathComponent

        public java.lang.String getPathComponent()
        Returns the path component for this item.

        You may want to reimplement this to customize the path component set by the item in the application internal path.

        See Also:
        setPathComponent(String path)

      • setInternalPathEnabled

        public void setInternalPathEnabled​(boolean enabled)
        Configures internal path support for the item.

        This configures whether the item supports internal paths (in a menu which supports internal paths).

        The default value is true for all items but section headers and separators.

        See Also:
        WMenu.setInternalPathEnabled(String basePath)

      • setLink

        public void setLink​(WLink link)
        Sets the associated link.

      • setSelectable

        public void setSelectable​(boolean selectable)
        Sets whether the menu item can be selected.

        Only a menu item that can be selected can be the result of a popup menu selection.

        The default value is true for a normal menu item, and false for a menu item that has a popup submenu.

        An item that is selectable but is disabled can still not be selected.

        Overrides:
        setSelectable in class WWebWidget

      • setData

        public void setData​(java.lang.Object data)
        Sets associated additional data with the item.

        You can use this to associate model information with a menu item.

      • getData

        public java.lang.Object getData()
        Returns additional data of the item.

        See Also:
        setData(Object data)

      • setCloseable

        public void setCloseable​(boolean closeable)
        Make it possible to close this item interactively or by close().

        See Also:
        close(), isCloseable()

      • getParentMenu

        public WMenu getParentMenu()
        Returns the menu that contains this item.

      • setContents

        public void setContents​(WWidget contents,
                        ContentLoading policy)
        Sets the contents widget for this item.

        The contents is a widget that will be shown in the WMenu contents stack when the item is selected. For this widget, the load policy specifies whether the contents widgets is transmitted only when it the item is activated for the first time (LazyLoading) or transmitted prior to first rendering.

      • getRemoveContents

        public WWidget getRemoveContents()
        Removes the contents widget from this item.

      • select

        public void select()
        Selects this item.

        If the item was previously closed it will be shown.

        See Also:
        close()

      • triggered

        public Signal1<WMenuItem> triggered()
        Signal emitted when an item is activated.

        Returns this item as argument.

      • isSeparator

        public boolean isSeparator()
        Returns whether this item is a separator.

        See Also:
        WMenu.addSeparator()

      • getAnchor

        public WAnchor getAnchor()
        Returns the anchor of this menu item.

        Can be used to add widgets to the menu.

      • renderSelected

        public void renderSelected​(boolean selected)
        Renders the item as selected or unselected.

        The default implementation sets the styleclass for itemWidget() to 'item' for an unselected not closeable, 'itemselected' for selected not closeable, 'citem' for an unselected closeable and 'citemselected' for selected closeable item.

        Note that this method is called from within a stateless slot implementation, and thus should be stateless as well.

      • enableAjax

        public void enableAjax()
        Description copied from class: WWidget
        Progresses to an Ajax-enabled widget.

        This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.

        You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.

        Overrides:
        enableAjax in class WWebWidget
        See Also:
        WApplication.enableAjax()

      • setHidden

        public void setHidden​(boolean hidden,
                      WAnimation animation)
        Description copied from class: WWidget
        Hides or shows the widget.

        Hides or show the widget (including all its descendant widgets). When setting hidden = false, this widget and all descendant widgets that are not hidden will be shown. A widget is only visible if it and all its ancestors in the widget tree are visible, which may be checked using isVisible().

        Overrides:
        setHidden in class WWebWidget

      • setDisabled

        public void setDisabled​(boolean disabled)
        Description copied from class: WWidget
        Sets whether the widget is disabled.

        The widget can be set to being disabled, or enabled. This state will also be propagated to all its descendants. Those descendants will only be "visually" made disabled, their actual isDisabled() state will remain unaltered. All descendants will be assigned the disabled styleclass, which is dependent on the used Theme.

        The isDisabled() check will thus only return true in case setDisabled(true) has been called on the widget before. If the anscestor of a widget has been marked setDisabled(true), the widget's isDisabled() state will remain false.

        To check if a widget has been passively disabled, by one of its anscestors, use isEnabled().

        Typically, a disabled form widget will not allow changing the value, and disabled widgets will not react to mouse click events.

        Overrides:
        setDisabled in class WWebWidget
        See Also:
        WWidget.disable(), WWidget.enable()

      • render

        protected void render​(java.util.EnumSet<RenderFlag> flags)
        Description copied from class: WWidget
        Renders the widget.

        This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

        The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

        Overrides:
        render in class WInteractWidget