Package com.bitwig.extension.controller.api

Interface BrowserFilterColumn

All Superinterfaces:

BrowserColumn, ObjectProxy, Subscribable

All Known Subinterfaces:

CursorBrowserFilterColumn

public interface BrowserFilterColumn
extends BrowserColumn

Instances of this interface are used to navigate a filter column in the Bitwig Studio browser.

Since:

API version 1

Method Summary

Modifier and Type	Method	Description
void	addNameObserver(int maxCharacters, String textWhenUnassigned, StringValueChangedCallback callback)	Deprecated. Use name() instead.
BrowserFilterItem	createCursorItem()	Returns the cursor filter item, which can be used to navigate over the list of entries.
BrowserFilterItemBank	createItemBank(int size)	Returns an object that provides access to a bank of successive entries using a window configured with the given size, that can be scrolled over the list of entries.
BrowserFilterItem	getWildcardItem()	Returns the filter item that represents the top-level all/any/everything wildcard item.
StringValue	name()	Value that reports the name of the filter column.

Methods inherited from interface com.bitwig.extension.controller.api.BrowserColumn

addEntryCountObserver, addExistsObserver, entryCount

Methods inherited from interface com.bitwig.extension.controller.api.ObjectProxy

createEqualsValue, exists

Methods inherited from interface com.bitwig.extension.controller.api.Subscribable

isSubscribed, setIsSubscribed, subscribe, unsubscribe

Method Details

getWildcardItem

BrowserFilterItem getWildcardItem()

Returns the filter item that represents the top-level all/any/everything wildcard item.

Returns:

the requested filter item object

Since:

API version 1

createCursorItem

BrowserFilterItem createCursorItem()

Returns the cursor filter item, which can be used to navigate over the list of entries.

Specified by:

createCursorItem in interface BrowserColumn

Returns:

the requested filter item object

Since:

API version 1

createItemBank

BrowserFilterItemBank createItemBank(int size)

Returns an object that provides access to a bank of successive entries using a window configured with the given size, that can be scrolled over the list of entries.

Specified by:

createItemBank in interface BrowserColumn

Parameters:

size - the number of simultaneously accessible items

Returns:

the requested item bank object

name

StringValue name()

Value that reports the name of the filter column.

Since:

API version2

addNameObserver

@Deprecated
void addNameObserver(int maxCharacters,
 String textWhenUnassigned,
 StringValueChangedCallback callback)

Deprecated.

Use name() instead.

Registers an observer that reports the name of the filter column.

Parameters:

callback - a callback function that receives a single string argument.

Since:

API version 1