All Superinterfaces:: IKStringArrayContainer, IStringArrayContainer

All Known Implementing Classes:: CodeItemArrayProp, EUIComboBox, EUISpinner, UIAbstractListChoice, UIComboBox, UISpinner

public interface ICodeItemArrayContainer extends IStringArrayContainer, IKStringArrayContainer

Interface implements by containers that can contain String elements of some kind.

Author:: Christopher Mindus

Method Summary
Modifier and Type
Method
Description
default void
addItem(ICodeItem item)
Adds a new item.
default void
addItem(KString item)
Adds a new item.
default void
addItem(String item)
Adds a new item.
default void
addItems(ICodeItem... items)
Adds a new items.
default void
addItems(Collection<ICodeItem> items)
Adds a new items.
default ICodeItemArrayContainer
getCodeArrayArrayContainer()
Gets the target implementor of the interface.
default ICodeItem
getItem(int index)
Gets the item at the specified index as a KString.
default int
getItemCount()
Gets the item count.
default int
getItemIndex(ICodeItem item)
Gets the index of of item.
default KString
getItemKString(int index)
Gets the item at the specified index as a KString.
default ICodeItem[]
getItems()
Gets the array of items.
default String
getItemString(int index)
Gets the item at the specified index as a String.
default void
insertItem(ICodeItem item, int index)
Inserts an item at specified index.
default void
insertItem(KString item, int index)
Inserts an item at specified index.
default void
insertItem(String item, int index)
Inserts an item at specified index.
default void
removeAllItems()
Removes all items.
default void
removeAllItems(boolean keepSelection)
Removes all items but keeps the selection depending on the flag.
default ICodeItem
removeItem(int index)
Removes an item.
default int
removeItem(ICodeItem item)
Removes an item.
default ICodeItem
setItem(ICodeItem item, int index)
Sets an item at specified index.
default KString
setItem(KString item, int index)
Sets an item at specified index.
default String
setItem(String item, int index)
Sets an item at specified index.
default void
sortItems()
Sorts the list according to the default JVM locale case sensitively.
default void
sortItems(boolean isCaseInsensitive)
Sorts the list according to the default JVM locale.
default void
sortItems(Locale locale)
Sorts the list according to a locale case sensitively.
default void
sortItems(Locale locale, boolean isCaseInsensitive)
Sorts the list according to a locale.
Methods inherited from interface com.iizix.prop.IKStringArrayContainer
addItems, getItemsAsKStrings, getKStringArrayContainer, isHTMLKStringSupported, removeItem
Methods inherited from interface com.iizix.prop.IStringArrayContainer
addItems, getItemsAsStrings, getStringArrayContainer, removeItem

Method Details
- getCodeArrayArrayContainer
  default ICodeItemArrayContainer getCodeArrayArrayContainer()
  Gets the target implementor of the interface.
  Returns:
  The target implements of the interface, null for none (this instance).
- getItems
  default ICodeItem[] getItems()
  Gets the array of items.
  Returns:
  An array of code items.
- getItem
  default ICodeItem getItem(int index)
  Gets the item at the specified index as a KString.
  Parameters:
  index - The index.
  Returns:
  The KString item.
  Throws:
  IndexOutOfBoundsException - If the index is invalid.
- getItemIndex
  default int getItemIndex(ICodeItem item)
  Gets the index of of item.
  Parameters:
  item - The item.
  Returns:
  The index of the item, or -1 if not found or item is null.
- getItemString
  default String getItemString(int index)
  Gets the item at the specified index as a String.
  Specified by:
  getItemString in interface IStringArrayContainer
  Parameters:
  index - The index.
  Returns:
  The String item.
  Throws:
  IndexOutOfBoundsException - If the index is invalid.
- getItemKString
  default KString getItemKString(int index)
  Gets the item at the specified index as a KString.
  Specified by:
  getItemKString in interface IKStringArrayContainer
  Parameters:
  index - The index.
  Returns:
  The KString item.
  Throws:
  IndexOutOfBoundsException - If the index is invalid.
- getItemCount
  default int getItemCount()
  Gets the item count.
  Specified by:
  getItemCount in interface IKStringArrayContainer
  Specified by:
  getItemCount in interface IStringArrayContainer
  Returns:
  The count of items.
- sortItems
  default void sortItems()
  Sorts the list according to the default JVM locale case sensitively.
  The selected index may change as a result of the sorting if selection is supported.
  Specified by:
  sortItems in interface IKStringArrayContainer
  Specified by:
  sortItems in interface IStringArrayContainer
  Throws:
  IllegalStateException - If the container is read-only.
- sortItems
  default void sortItems(boolean isCaseInsensitive)
  Sorts the list according to the default JVM locale.
  The selected index may change as a result of the sorting if selection is supported.
  Specified by:
  sortItems in interface IKStringArrayContainer
  Specified by:
  sortItems in interface IStringArrayContainer
  Parameters:
  isCaseInsensitive - Flag for case insensitive.
  Throws:
  IllegalStateException - If the container is read-only.
- sortItems
  default void sortItems(Locale locale)
  Sorts the list according to a locale case sensitively.
  The selected index may change as a result of the sorting if selection is supported.
  Specified by:
  sortItems in interface IKStringArrayContainer
  Specified by:
  sortItems in interface IStringArrayContainer
  Parameters:
  locale - The locale to use for string sorting.
  Throws:
  IllegalStateException - If the container is read-only.
- sortItems
  default void sortItems(Locale locale, boolean isCaseInsensitive)
  Sorts the list according to a locale.
  The selected index may change as a result of the sorting if selection is supported.
  Specified by:
  sortItems in interface IKStringArrayContainer
  Specified by:
  sortItems in interface IStringArrayContainer
  Parameters:
  locale - The locale to use for string sorting, null for default..
  isCaseInsensitive - Flag for case insensitive.
  Throws:
  IllegalStateException - If the container is read-only.
- addItem
  default void addItem(ICodeItem item)
  Adds a new item.
  Parameters:
  item - The item to add.
  Throws:
  NullPointerException - If the item is null.
  IllegalStateException - If the container is read-only.
- addItem
  default void addItem(String item)
  Adds a new item.
  Specified by:
  addItem in interface IStringArrayContainer
  Parameters:
  item - The item to add.
  Throws:
  NullPointerException - If the item is null.
  IllegalStateException - If the container is read-only.
- addItem
  default void addItem(KString item)
  Adds a new item.
  Specified by:
  addItem in interface IKStringArrayContainer
  Parameters:
  item - The item to add.
  Throws:
  NullPointerException - If the item is null.
  IllegalStateException - If the container is read-only.
- addItems
  default void addItems(ICodeItem... items)
  Adds a new items.
  Parameters:
  items - The items to add.
  Throws:
  NullPointerException - If an item is null.
  IllegalStateException - If the container is read-only.
- addItems
  default void addItems(Collection<ICodeItem> items)
  Adds a new items.
  Parameters:
  items - The items to add.
  Throws:
  NullPointerException - If an item is null.
  IllegalStateException - If the container is read-only.
- insertItem
  default void insertItem(ICodeItem item, int index)
  Inserts an item at specified index.
  The selection may be changed due to this operation if the owner support selection.
  Parameters:
  item - The item to add.
  index - The index to insert the item before (-1 for last).
  Throws:
  NullPointerException - If the item is null.
  IndexOutOfBoundsException - If the index is in error.
  IllegalStateException - If the container is read-only.
- insertItem
  default void insertItem(String item, int index)
  Inserts an item at specified index.
  The selection may be changed due to this operation if the owner support selection.
  Specified by:
  insertItem in interface IStringArrayContainer
  Parameters:
  item - The item to add.
  index - The index to insert the item before (-1 for last).
  Throws:
  NullPointerException - If the item is null.
  IndexOutOfBoundsException - If the index is in error.
  IllegalStateException - If the container is read-only.
- insertItem
  default void insertItem(KString item, int index)
  Inserts an item at specified index.
  The selection may be changed due to this operation if the owner support selection.
  Specified by:
  insertItem in interface IKStringArrayContainer
  Parameters:
  item - The item to add.
  index - The index to insert the item before (-1 for last).
  Throws:
  NullPointerException - If the item is null.
  IndexOutOfBoundsException - If the index is in error.
  IllegalStateException - If the container is read-only.
- setItem
  default ICodeItem setItem(ICodeItem item, int index)
  Sets an item at specified index.
  Parameters:
  item - The item to set.
  index - The index of the item.
  Returns:
  The old item.
  Throws:
  NullPointerException - If the item is null.
  IndexOutOfBoundsException - If the index is in error.
  IllegalStateException - If the container is read-only.
- setItem
  default String setItem(String item, int index)
  Sets an item at specified index.
  Specified by:
  setItem in interface IStringArrayContainer
  Parameters:
  item - The item to set.
  index - The index of the item.
  Returns:
  The old item.
  Throws:
  NullPointerException - If the item is null.
  IndexOutOfBoundsException - If the index is in error.
  IllegalStateException - If the container is read-only.
- setItem
  default KString setItem(KString item, int index)
  Sets an item at specified index.
  Specified by:
  setItem in interface IKStringArrayContainer
  Parameters:
  item - The item to set.
  index - The index of the item.
  Returns:
  The old item.
  Throws:
  NullPointerException - If the item is null.
  IndexOutOfBoundsException - If the index is in error.
  IllegalStateException - If the container is read-only.
- removeItem
  default ICodeItem removeItem(int index)
  Removes an item.
  The selection may be changed due to this operation if the owner support selection.
  Specified by:
  removeItem in interface IKStringArrayContainer
  Specified by:
  removeItem in interface IStringArrayContainer
  Parameters:
  index - The index of the item to delete.
  Returns:
  The item deleted.
  Throws:
  IndexOutOfBoundsException - If the index is in error.
  IllegalStateException - If the container is read-only.
- removeItem
  default int removeItem(ICodeItem item)
  Removes an item.
  The selection may be changed due to this operation if the owner support selection.
  Parameters:
  item - The item to remove.
  Returns:
  The index of the item removed, -1 if not found.
  Throws:
  IndexOutOfBoundsException - If the index is in error.
  IllegalStateException - If the container is read-only.
- removeAllItems
  default void removeAllItems()
  Removes all items.
  The selection may be changed (cleared) due to this operation if the owner support selection.
  Specified by:
  removeAllItems in interface IKStringArrayContainer
  Specified by:
  removeAllItems in interface IStringArrayContainer
  Throws:
  IllegalStateException - If the container is read-only.
- removeAllItems
  default void removeAllItems(boolean keepSelection)
  Removes all items but keeps the selection depending on the flag.
  The selection may be changed (cleared) due to this operation if the owner support selection.
  Specified by:
  removeAllItems in interface IKStringArrayContainer
  Specified by:
  removeAllItems in interface IStringArrayContainer
  Parameters:
  keepSelection - The boolean to keep the selection.
  Throws:
  IllegalStateException - If the container is read-only.

Interface ICodeItemArrayContainer

Method Summary

Methods inherited from interface com.iizix.prop.IKStringArrayContainer

Methods inherited from interface com.iizix.prop.IStringArrayContainer

Method Details

getCodeArrayArrayContainer

getItems

getItem

getItemIndex

getItemString

getItemKString

getItemCount

sortItems

sortItems

sortItems

sortItems

addItem

addItem

addItem

addItems

addItems

insertItem

insertItem

insertItem

setItem

setItem

setItem

removeItem

removeItem

removeAllItems

removeAllItems