Class AbstractItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

java.lang.Object

ch.nolix.system.element.mutableelement.AbstractMutableElement

ch.nolix.system.style.stylable.AbstractStylableElement<M>

ch.nolix.system.webgui.main.Control<M,S>

ch.nolix.system.webatomiccontrol.itemmenu.AbstractItemMenu<M,S>

Type Parameters:

M - is the type of a AbstractItemMenu.

S - is the type of the IItemMenuStyles of a AbstractItemMenu.

All Implemented Interfaces:

IFluentMutableMultiTokenHolder<M>, IFluentMutableOptionalIdHolder<M>, IMultiTokenHolder, IOptionalIdHolder, Linkable, LinkedRequestable, TypeRequestable, Clearable, Resettable, EmptinessRequestable, IHtmlGetter, IElement, IStructureElement, IMutableElement, ISizeAdjustableBox<M>, PresenceRequestable, PresenceSettable<M>, IStylableElement<M>, IItemMenu<M,S>, IControl<M,S>, IUserInputCell<M>

Direct Known Subclasses:

DropdownMenu

public abstract class AbstractItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>
extends Control<M,S>
implements IItemMenu<M,S>

Author:

Silvan Wyss

Field Summary

Fields inherited from class Control

DEFAULT_CURSOR_ICON, DEFAULT_PRESENCE

Constructor Summary

Constructors

Constructor	Description
AbstractItemMenu()

Method Summary

Modifier and Type	Method	Description
final M	addBlankItem()
final M	addItem(IItemMenuItem<?> item, IItemMenuItem<?>... items)
final M	addItemWithIdAndText(String id, String text)
final M	addItemWithIdAndTextAndSelectAction(String id, String text, Runnable selectAction)
final M	addItemWithIdAndTextAndSelectAction(String id, String text, Consumer<IItemMenuItem<?>> selectAction)
final M	addItemWithText(String text, String... texts)
final M	addItemWithTextAndSelectAction(String text, Runnable selectAction)
final M	addItemWithTextAndSelectAction(String text, Consumer<IItemMenuItem<?>> selectAction)
final boolean	blankItemIsSelected()
final void	clear()	Removes the elements of the current Clearable.
final boolean	containsBlankItem()
final boolean	containsItemWithId(String id)
final boolean	containsItemWithText(String text)
final boolean	containsSelectedItem()
final String	getIdByItemText(String itemText)
final IContainer<IControl<?,?>>	getStoredChildControls()
final IContainer<IItemMenuItem<?>>	getStoredItems()
final IItemMenuItem<?>	getStoredSelectedItem()
final String	getTextByItemId(String itemId)
final String	getUserInput()
final boolean	hasRole(String role)
final void	internalRunOptionalSelectActionForItem(IItemMenuItem<?> item)
final boolean	isEmpty()
final void	removeSelectAction()
final void	runHtmlEvent(String htmlEvent)
final M	selectBlankItem()
final M	selectFirstItem()
final M	selectItemById(String id)
final M	selectItemByText(String text)
final M	setSelectAction(Runnable selectAction)
final M	setSelectAction(Consumer<IItemMenuItem<?>> selectAction)
final M	setUserInput(String userInput)

Methods inherited from class Control

belongsToControl, belongsToGui, belongsToLayer, editStyle, getCssRules, getCursorIcon, getHtml, getInternalId, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOptionalStoredChildControlByInternalId, getPresence, getStoredChildStylableElements, getStoredLinkedObjects, getStoredParentControl, getStoredParentGui, getStoredParentLayer, getStoredStyle, hasInternalId, hasMaxHeight, hasMaxWidth, hasMinHeight, hasMinWidth, internalSetParentControl, internalSetParentLayer, isCollapsed, isInvisible, isLinkedTo, isLinkedToAnObject, isVisible, linkTo, removeMaxHeight, removeMaxWidth, removeMinHeight, removeMinWidth, setCollapsed, setCursorIcon, setInvisible, setMaxHeight, setMaxHeightInPercentOfViewAreaHeight, setMaxWidth, setMaxWidthInPercentOfViewAreaWidth, setMinHeight, setMinHeightInPercentOfViewAreaHeight, setMinWidth, setMinWidthInPercentOfViewAreaWidth, setVisibility, setVisible

Methods inherited from class AbstractStylableElement

addToken, getChildStructureElements, getId, getTokens, hasId, removeId, removeToken, removeTokens, reset, resetStyleRecursively, setId

Methods inherited from class AbstractMutableElement

addOrChangeAttribute, addOrChangeAttribute, equals, getAttributes, getSpecification, hashCode, resetFromFileWithFilePath, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface EmptinessRequestable

containsAny

Methods inherited from interface IControl

belongsToControl, belongsToGui, belongsToLayer, editStyle, getCssRules, getCursorIcon, getInternalId, getOptionalJavaScriptUserInputFunction, getOptionalStoredChildControlByInternalId, getStoredParentControl, getStoredParentGui, getStoredParentLayer, getStoredStyle, hasInternalId, internalSetParentControl, internalSetParentLayer, registerHtmlElementEventsAt, setCursorIcon

Methods inherited from interface IElement

getAttributes, getSpecification, toFormatedString, toXml

Methods inherited from interface IFluentMutableMultiTokenHolder

addToken, removeToken, removeTokens

Methods inherited from interface IFluentMutableOptionalIdHolder

removeId, setId

Methods inherited from interface IHtmlGetter

getHtml

Methods inherited from interface IMultiTokenHolder

getTokens

Methods inherited from interface IMutableElement

addOrChangeAttribute, addOrChangeAttribute, addOrChangeAttributes, addOrChangeAttributes, addOrChangeAttributes, resetFromAttributes, resetFromSpecification

Methods inherited from interface IOptionalIdHolder

getId, getIdInQuotes, hasId, hasId

Methods inherited from interface ISizeAdjustableBox

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, hasMaxHeight, hasMaxWidth, hasMinHeight, hasMinWidth, removeMaxHeight, removeMaxWidth, removeMinHeight, removeMinWidth, setMaxHeight, setMaxHeightInPercentOfViewAreaHeight, setMaxWidth, setMaxWidthInPercentOfViewAreaWidth, setMinHeight, setMinHeightInPercentOfViewAreaHeight, setMinWidth, setMinWidthInPercentOfViewAreaWidth

Methods inherited from interface IStructureElement

getChildStructureElements

Methods inherited from interface IStylableElement

getStoredChildStylableElements, resetStyleRecursively

Methods inherited from interface Linkable

linkTo

Methods inherited from interface LinkedRequestable

getStoredLinkedObjects, isLinkedTo, isLinkedToAnObject

Methods inherited from interface PresenceRequestable

getPresence, isCollapsed, isInvisible, isVisible

Methods inherited from interface PresenceSettable

setCollapsed, setInvisible, setVisibility, setVisible

Methods inherited from interface Resettable

reset

Methods inherited from interface TypeRequestable

getType, isOfConcreteType, isOfConcreteType, isOfType, isOfType

Constructor Details

AbstractItemMenu

public AbstractItemMenu()

Method Details

addBlankItem

public final M addBlankItem()

Specified by:

addBlankItem in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

addItem

public final M addItem(IItemMenuItem<?> item,
 IItemMenuItem<?>... items)

Specified by:

addItem in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

addItemWithIdAndText

public final M addItemWithIdAndText(String id,
 String text)

Specified by:

addItemWithIdAndText in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

addItemWithIdAndTextAndSelectAction

public final M addItemWithIdAndTextAndSelectAction(String id,
 String text,
 Runnable selectAction)

Specified by:

addItemWithIdAndTextAndSelectAction in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

addItemWithIdAndTextAndSelectAction

public final M addItemWithIdAndTextAndSelectAction(String id,
 String text,
 Consumer<IItemMenuItem<?>> selectAction)

Specified by:

addItemWithIdAndTextAndSelectAction in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

addItemWithText

public final M addItemWithText(String text,
 String... texts)

Specified by:

addItemWithText in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

addItemWithTextAndSelectAction

public final M addItemWithTextAndSelectAction(String text,
 Runnable selectAction)

Specified by:

addItemWithTextAndSelectAction in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

addItemWithTextAndSelectAction

public final M addItemWithTextAndSelectAction(String text,
 Consumer<IItemMenuItem<?>> selectAction)

Specified by:

addItemWithTextAndSelectAction in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

blankItemIsSelected

public final boolean blankItemIsSelected()

Specified by:

blankItemIsSelected in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

clear

public final void clear()

Removes the elements of the current Clearable.

Specified by:

clear in interface Clearable

containsBlankItem

public final boolean containsBlankItem()

Specified by:

containsBlankItem in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

containsItemWithId

public final boolean containsItemWithId(String id)

Specified by:

containsItemWithId in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

containsItemWithText

public final boolean containsItemWithText(String text)

Specified by:

containsItemWithText in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

containsSelectedItem

public final boolean containsSelectedItem()

Specified by:

containsSelectedItem in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

getIdByItemText

public final String getIdByItemText(String itemText)

Specified by:

getIdByItemText in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

getStoredChildControls

public final IContainer<IControl<?,?>> getStoredChildControls()

Specified by:

getStoredChildControls in interface IControl<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

getStoredItems

public final IContainer<IItemMenuItem<?>> getStoredItems()

Specified by:

getStoredItems in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

getStoredSelectedItem

public final IItemMenuItem<?> getStoredSelectedItem()

Specified by:

getStoredSelectedItem in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

getTextByItemId

public final String getTextByItemId(String itemId)

Specified by:

getTextByItemId in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

getUserInput

public final String getUserInput()

Specified by:

getUserInput in interface IUserInputCell<M extends IItemMenu<M,S>>

hasRole

public final boolean hasRole(String role)

Specified by:

hasRole in interface IStylableElement<M extends IItemMenu<M,S>>

Parameters:

role -

Returns:

true if the current IStylableElement has the given role, false otherwise.

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface EmptinessRequestable

Returns:

true if EmptinessRequestable does not contain an element, false otherwise.

removeSelectAction

public final void removeSelectAction()

Specified by:

removeSelectAction in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

runHtmlEvent

public final void runHtmlEvent(String htmlEvent)

Specified by:

runHtmlEvent in interface IControl<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

selectBlankItem

public final M selectBlankItem()

Specified by:

selectBlankItem in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

selectFirstItem

public final M selectFirstItem()

Specified by:

selectFirstItem in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

selectItemById

public final M selectItemById(String id)

Specified by:

selectItemById in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

selectItemByText

public final M selectItemByText(String text)

Specified by:

selectItemByText in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

setSelectAction

public final M setSelectAction(Runnable selectAction)

Specified by:

setSelectAction in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

setSelectAction

public final M setSelectAction(Consumer<IItemMenuItem<?>> selectAction)

Specified by:

setSelectAction in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>

setUserInput

public final M setUserInput(String userInput)

Specified by:

setUserInput in interface IUserInputCell<M extends IItemMenu<M,S>>

internalRunOptionalSelectActionForItem

public final void internalRunOptionalSelectActionForItem(IItemMenuItem<?> item)

Specified by:

internalRunOptionalSelectActionForItem in interface IItemMenu<M extends IItemMenu<M,S>, S extends IItemMenuStyle<S>>