com.spvessel.spacevil.ItemsLayoutBox Class Reference

ItemsLayoutBox is a storage-class that provides an access to existing items. More...

Static Public Member Functions
static List< InterfaceBaseItem >	getLayoutItems (UUID id)
	Getting existing static items in specified window by its GUID. More...
static List< InterfaceBaseItem >	getLayoutFloatItems (UUID id)
	Getting existing float items in specified window by its UUID. More...
static void	addItem (CoreWindow layout, InterfaceBaseItem item, LayoutType type)
	Adding an item to global item storage (ItemsLayoutBox). More...
static boolean	removeItem (CoreWindow layout, InterfaceBaseItem item, LayoutType type)
	Removing an item from global item storage (ItemsLayoutBox). More...
static String[]	getListOfItemsNames (CoreWindow layout)
	Getting the list of names of existing items in the specified window. More...
static void	printListOfItems (CoreWindow layout)
	Printing all existing items in the specified window. More...

Detailed Description

ItemsLayoutBox is a storage-class that provides an access to existing items.

Member Function Documentation

addItem()

static void com.spvessel.spacevil.ItemsLayoutBox.addItem ( CoreWindow  layout, InterfaceBaseItem  item, LayoutType  type  )

static

Adding an item to global item storage (ItemsLayoutBox).

In usual situation you do not need to use this function only if you create your own implementation of InterfaceBaseItem or create a new implementation of InterfaceFloatItem.

Parameters

layout	Any CoreWindow instance.
item	Any InterfaceBaseItem instance.
type	Type of an item: com.spvessel.spacevil.Flags.LayoutType.STATIC or com.spvessel.spacevil.Flags.LayoutType.FLOATING.

getLayoutFloatItems()

static List<InterfaceBaseItem> com.spvessel.spacevil.ItemsLayoutBox.getLayoutFloatItems ( UUID  id )

static

Getting existing float items in specified window by its UUID.

Floating items are independent items that do not have a parent, or their root parent is a floating item. Examples: SideArea, FloatItem, ContextMenu and etc.

Parameters

id	UUID of the window.

Returns

The list of existing float items in specified window by its UUID.

getLayoutItems()

static List<InterfaceBaseItem> com.spvessel.spacevil.ItemsLayoutBox.getLayoutItems ( UUID  id )

static

Getting existing static items in specified window by its GUID.

Static items are items that depend on their parent. Parent controls their size, position and etc.

Parameters

id	UUID of the window.

Returns

The list of existing static items in specified window by its UUID.

getListOfItemsNames()

static String [] com.spvessel.spacevil.ItemsLayoutBox.getListOfItemsNames ( CoreWindow  layout )

static

Getting the list of names of existing items in the specified window.

Parameters

layout

Any CoreWindow instance.

Returns

The list of names of existing items in the specified window.

printListOfItems()

static void com.spvessel.spacevil.ItemsLayoutBox.printListOfItems ( CoreWindow  layout )

static

Printing all existing items in the specified window.

Parameters

layout

Any CoreWindow instance.

removeItem()

static boolean com.spvessel.spacevil.ItemsLayoutBox.removeItem ( CoreWindow  layout, InterfaceBaseItem  item, LayoutType  type  )

static

Removing an item from global item storage (ItemsLayoutBox).

In usual situation you do not need to use this function only if you create your own implementation of InterfaceBaseItem or want to remove IFloatItem instance.

Parameters

layout	Any CoreWindow instance.
item	Any InterfaceBaseItem instance.
type	Type of an item: com.spvessel.spacevil.Flags.LayoutType.STATIC or com.spvessel.spacevil.Flags.LayoutType.FLOATING.

Returns

True: if removal was successfull. False: if the specified item does not exist in the storage.

---

The documentation for this class was generated from the following file:

• ItemsLayoutBox.java