org.icefaces.ace.component.multicolumnsubmenu

## Class MultiColumnSubmenuBase

- java.lang.Object
- - javax.faces.component.UIComponent
  - - javax.faces.component.UIComponentBase
    - - org.icefaces.ace.component.multicolumnsubmenu.MultiColumnSubmenuBase

- All Implemented Interfaces:
    java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IMultiColumnSubmenu
  Direct Known Subclasses:
    MultiColumnSubmenu

      public abstract class MultiColumnSubmenuBase
      extends javax.faces.component.UIComponentBase
      implements IMultiColumnSubmenu

  MultiColumnSubmenu is nested in a menu component and represents a navigation group with one or more MenuColumn's.It supports the 'header' and 'footer' facets to include arbitrary components at the top and bottom of the submenu.

  For more information, see the MultiColumnSubmenu Wiki Documentation.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `MultiColumnSubmenuBase.PropertyKeys`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static java.lang.String` | `COMPONENT_TYPE`
    `static java.lang.String` | `RENDERER_TYPE`

    - ### Fields inherited from class javax.faces.component.UIComponent

      `ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MultiColumnSubmenuBase()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getFamily()`
    `java.lang.String` | `getFooterClass()` Return the value of the `footerClass` property.
    `java.lang.String` | `getHeaderClass()` Return the value of the `headerClass` property.
    `java.lang.String` | `getIcon()` Return the value of the `icon` property.
    `java.lang.String` | `getLabel()` Return the value of the `label` property.
    `java.lang.Integer` | `getPositionLeft()` Return the value of the `positionLeft` property.
    `java.lang.Integer` | `getPositionTop()` Return the value of the `positionTop` property.
    `java.lang.String` | `getRelativeTo()` Return the value of the `relativeTo` property.
    `java.lang.String` | `getStyle()` Return the value of the `style` property.
    `java.lang.String` | `getStyleClass()` Return the value of the `styleClass` property.
    `boolean` | `isDisabled()` Return the value of the `disabled` property.
    `protected boolean` | `isPropertySet(java.lang.String finder)`
    `void` | `setDisabled(boolean disabled)` Set the value of the `disabled` property.
    `void` | `setFooterClass(java.lang.String footerClass)` Set the value of the `footerClass` property.
    `void` | `setHeaderClass(java.lang.String headerClass)` Set the value of the `headerClass` property.
    `void` | `setIcon(java.lang.String icon)` Set the value of the `icon` property.
    `void` | `setLabel(java.lang.String label)` Set the value of the `label` property.
    `void` | `setPositionLeft(java.lang.Integer positionLeft)` Set the value of the `positionLeft` property.
    `void` | `setPositionTop(java.lang.Integer positionTop)` Set the value of the `positionTop` property.
    `void` | `setRelativeTo(java.lang.String relativeTo)` Set the value of the `relativeTo` property.
    `void` | `setStyle(java.lang.String style)` Set the value of the `style` property.
    `void` | `setStyleClass(java.lang.String styleClass)` Set the value of the `styleClass` property.
    `void` | `setValueExpression(java.lang.String name, javax.el.ValueExpression binding)`

    - ### Methods inherited from class javax.faces.component.UIComponentBase

      `addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent`

    - ### Methods inherited from class javax.faces.component.UIComponent

      `encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### COMPONENT_TYPE

          public static final java.lang.String COMPONENT_TYPE

      See Also:
        Constant Field Values

    - #### RENDERER_TYPE

          public static final java.lang.String RENDERER_TYPE

  - ### Constructor Detail

    - #### MultiColumnSubmenuBase

          public MultiColumnSubmenuBase()

  - ### Method Detail

    - #### getFamily

          public java.lang.String getFamily()

      Specified by:
        `getFamily` in class `javax.faces.component.UIComponent`

    - #### setDisabled

          public void setDisabled(boolean disabled)

      Set the value of the `disabled` property.

      Contents: Boolean value to disable/enable the multi-column submenu. The submenu label will still be shown but with different styling, and clicking or hovering on it will not display its children submenus and menu items.

      Specified by:
        `setDisabled` in interface `IMultiColumnSubmenu`

    - #### isDisabled

          public boolean isDisabled()

      Return the value of the `disabled` property.

      Contents: Boolean value to disable/enable the multi-column submenu. The submenu label will still be shown but with different styling, and clicking or hovering on it will not display its children submenus and menu items.

      Specified by:
        `isDisabled` in interface `IMultiColumnSubmenu`

    - #### setFooterClass

          public void setFooterClass(java.lang.String footerClass)

      Set the value of the `footerClass` property.

      Contents: Style class of the submenu footer.

      Specified by:
        `setFooterClass` in interface `IMultiColumnSubmenu`

    - #### getFooterClass

          public java.lang.String getFooterClass()

      Return the value of the `footerClass` property.

      Contents: Style class of the submenu footer.

      Specified by:
        `getFooterClass` in interface `IMultiColumnSubmenu`

    - #### setHeaderClass

          public void setHeaderClass(java.lang.String headerClass)

      Set the value of the `headerClass` property.

      Contents: Style class of the submenu header.

      Specified by:
        `setHeaderClass` in interface `IMultiColumnSubmenu`

    - #### getHeaderClass

          public java.lang.String getHeaderClass()

      Return the value of the `headerClass` property.

      Contents: Style class of the submenu header.

      Specified by:
        `getHeaderClass` in interface `IMultiColumnSubmenu`

    - #### setIcon

          public void setIcon(java.lang.String icon)

      Set the value of the `icon` property.

      Contents: CSS class name(s) containing the styling to display an icon.

      Specified by:
        `setIcon` in interface `IMultiColumnSubmenu`

    - #### getIcon

          public java.lang.String getIcon()

      Return the value of the `icon` property.

      Contents: CSS class name(s) containing the styling to display an icon.

      Specified by:
        `getIcon` in interface `IMultiColumnSubmenu`

    - #### setLabel

          public void setLabel(java.lang.String label)

      Set the value of the `label` property.

      Contents: Label of the submenu header.

      Specified by:
        `setLabel` in interface `IMultiColumnSubmenu`

    - #### getLabel

          public java.lang.String getLabel()

      Return the value of the `label` property.

      Contents: Label of the submenu header.

      Specified by:
        `getLabel` in interface `IMultiColumnSubmenu`

    - #### setPositionLeft

          public void setPositionLeft(java.lang.Integer positionLeft)

      Set the value of the `positionLeft` property.

      Contents: Specifies a 'left' position (in pixels) that will override the automatic positioning of the submenu. This value is relative to the 'left' position of the submenu label or of the menu bar (see 'relativeTo' attribute). A negative value means that this custom position is to the left the reference point, while and positive value means that this custom position is to the right.

      Specified by:
        `setPositionLeft` in interface `IMultiColumnSubmenu`

    - #### getPositionLeft

          public java.lang.Integer getPositionLeft()

      Return the value of the `positionLeft` property.

      Contents: Specifies a 'left' position (in pixels) that will override the automatic positioning of the submenu. This value is relative to the 'left' position of the submenu label or of the menu bar (see 'relativeTo' attribute). A negative value means that this custom position is to the left the reference point, while and positive value means that this custom position is to the right.

      Specified by:
        `getPositionLeft` in interface `IMultiColumnSubmenu`

    - #### setPositionTop

          public void setPositionTop(java.lang.Integer positionTop)

      Set the value of the `positionTop` property.

      Contents: Specifies a 'top' position (in pixels) that will override the automatic positioning of the submenu. This value is relative to the 'top' position of the submenu label or of the menu bar (see 'relativeTo' attribute). A negative value means that this custom position is above the reference point, while and positive value means that this custom position is below.

      Specified by:
        `setPositionTop` in interface `IMultiColumnSubmenu`

    - #### getPositionTop

          public java.lang.Integer getPositionTop()

      Return the value of the `positionTop` property.

      Contents: Specifies a 'top' position (in pixels) that will override the automatic positioning of the submenu. This value is relative to the 'top' position of the submenu label or of the menu bar (see 'relativeTo' attribute). A negative value means that this custom position is above the reference point, while and positive value means that this custom position is below.

      Specified by:
        `getPositionTop` in interface `IMultiColumnSubmenu`

    - #### setRelativeTo

          public void setRelativeTo(java.lang.String relativeTo)

      Set the value of the `relativeTo` property.

      Contents: Specifies whether the 'positionLeft' and 'positionRight' attributes are relative to the submenu label or the menu bar. It also affects centering when using the value 'center' in 'direction. Possible values are 'label' and 'menubar'. The default value is 'label'.

      Specified by:
        `setRelativeTo` in interface `IMultiColumnSubmenu`

    - #### getRelativeTo

          public java.lang.String getRelativeTo()

      Return the value of the `relativeTo` property.

      Contents: Specifies whether the 'positionLeft' and 'positionRight' attributes are relative to the submenu label or the menu bar. It also affects centering when using the value 'center' in 'direction. Possible values are 'label' and 'menubar'. The default value is 'label'.

      Specified by:
        `getRelativeTo` in interface `IMultiColumnSubmenu`

    - #### setStyle

          public void setStyle(java.lang.String style)

      Set the value of the `style` property.

      Contents: Style of the submenu label.

      Specified by:
        `setStyle` in interface `IMultiColumnSubmenu`

    - #### getStyle

          public java.lang.String getStyle()

      Return the value of the `style` property.

      Contents: Style of the submenu label.

      Specified by:
        `getStyle` in interface `IMultiColumnSubmenu`

    - #### setStyleClass

          public void setStyleClass(java.lang.String styleClass)

      Set the value of the `styleClass` property.

      Contents: Style class of the submenu label.

      Specified by:
        `setStyleClass` in interface `IMultiColumnSubmenu`

    - #### getStyleClass

          public java.lang.String getStyleClass()

      Return the value of the `styleClass` property.

      Contents: Style class of the submenu label.

      Specified by:
        `getStyleClass` in interface `IMultiColumnSubmenu`

    - #### isPropertySet

          protected boolean isPropertySet(java.lang.String finder)

    - #### setValueExpression

          public void setValueExpression(java.lang.String name,
                                         javax.el.ValueExpression binding)

      Overrides:
        `setValueExpression` in class `javax.faces.component.UIComponent`

Copyright 2025 ICEsoft Technologies Canada, Corp. All Rights Reserved.