Package net.runelite.client.plugins.banktags

Class BankTagsPlugin

java.lang.Object

net.runelite.client.plugins.Plugin

net.runelite.client.plugins.banktags.BankTagsPlugin

All Implemented Interfaces:

com.google.inject.Module, BankTagsService

@PluginDescriptor(name="Bank Tags",
                  description="Enable tagging of bank items and searching of bank tags",
                  tags={"searching","tagging"})
public class BankTagsPlugin
extends Plugin
implements BankTagsService

Field Summary

Fields

Modifier and Type	Field	Description
static int	BANK_ITEM_HEIGHT
static int	BANK_ITEM_START_X
static int	BANK_ITEM_START_Y
static int	BANK_ITEM_WIDTH
static int	BANK_ITEM_X_PADDING
static int	BANK_ITEM_Y_PADDING
static int	BANK_ITEMS_PER_ROW
static String	CONFIG_GROUP
static String	TAG_ICON_PREFIX
static String	TAG_LAYOUT_PREFIX
static String	TAG_SEARCH
static String	TAG_TABS_CONFIG
static String	VAR_TAG_SUFFIX

Fields inherited from class net.runelite.client.plugins.Plugin

injector

Fields inherited from interface net.runelite.client.plugins.banktags.BankTagsService

OPTION_ALLOW_MODIFICATIONS, OPTION_HIDE_TAG_NAME, OPTION_NO_LAYOUT

Constructor Summary

Constructors

Constructor	Description
BankTagsPlugin()

Method Summary

Modifier and Type	Method	Description
void	closeBankTag()	Close the currently open BankTag.
void	configure(com.google.inject.Binder binder)
BankTag	getActiveBankTag()	Get the currently open BankTag
Layout	getActiveLayout()	Get the currently active Layout
String	getActiveTag()	Get the currently active bank tag
int	getOptions()
void	onConfigChanged(ConfigChanged configChanged)
void	onGrandExchangeSearched(net.runelite.api.events.GrandExchangeSearched event)
void	onMenuEntryAdded(net.runelite.api.events.MenuEntryAdded event)
void	onScriptCallbackEvent(net.runelite.api.events.ScriptCallbackEvent event)
void	openBankTag(String name)
void	openBankTag(String name, int options)	Open the given bank tag.
void	openTag(String tag, Layout layout)
void	openTag(String tag, Layout layout, int options)
void	resetConfiguration()
void	shutDown()
void	startUp()

Methods inherited from class net.runelite.client.plugins.Plugin

equals, getInjector, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_GROUP

public static final String CONFIG_GROUP

See Also:

Constant Field Values

TAG_ICON_PREFIX

public static final String TAG_ICON_PREFIX

See Also:

Constant Field Values

TAG_TABS_CONFIG

public static final String TAG_TABS_CONFIG

See Also:

Constant Field Values

TAG_LAYOUT_PREFIX

public static final String TAG_LAYOUT_PREFIX

See Also:

Constant Field Values

TAG_SEARCH

public static final String TAG_SEARCH

See Also:

Constant Field Values

VAR_TAG_SUFFIX

public static final String VAR_TAG_SUFFIX

See Also:

Constant Field Values

BANK_ITEM_WIDTH

public static final int BANK_ITEM_WIDTH

See Also:

Constant Field Values

BANK_ITEM_HEIGHT

public static final int BANK_ITEM_HEIGHT

See Also:

Constant Field Values

BANK_ITEM_X_PADDING

public static final int BANK_ITEM_X_PADDING

See Also:

Constant Field Values

BANK_ITEM_Y_PADDING

public static final int BANK_ITEM_Y_PADDING

See Also:

Constant Field Values

BANK_ITEMS_PER_ROW

public static final int BANK_ITEMS_PER_ROW

See Also:

Constant Field Values

BANK_ITEM_START_X

public static final int BANK_ITEM_START_X

See Also:

Constant Field Values

BANK_ITEM_START_Y

public static final int BANK_ITEM_START_Y

See Also:

Constant Field Values

Constructor Detail

BankTagsPlugin

public BankTagsPlugin()

Method Detail

configure

public void configure(com.google.inject.Binder binder)

Specified by:

configure in interface com.google.inject.Module

Overrides:

configure in class Plugin

resetConfiguration

public void resetConfiguration()

Overrides:

resetConfiguration in class Plugin

startUp

public void startUp()

Overrides:

startUp in class Plugin

shutDown

public void shutDown()

Overrides:

shutDown in class Plugin

onGrandExchangeSearched

@Subscribe
public void onGrandExchangeSearched(net.runelite.api.events.GrandExchangeSearched event)

onScriptCallbackEvent

@Subscribe
public void onScriptCallbackEvent(net.runelite.api.events.ScriptCallbackEvent event)

onMenuEntryAdded

@Subscribe
public void onMenuEntryAdded(net.runelite.api.events.MenuEntryAdded event)

onConfigChanged

@Subscribe
public void onConfigChanged(ConfigChanged configChanged)

openTag

public void openTag(String tag,
                    Layout layout)

openTag

public void openTag(String tag,
                    Layout layout,
                    int options)

openBankTag

public void openBankTag(String name)

openBankTag

public void openBankTag(String name,
                        int options)

Description copied from interface: BankTagsService

Open the given bank tag. The tag may have an associated TagTab, but this isn't required. If the tag has an associated Layout, the layout will be applied.

Specified by:

openBankTag in interface BankTagsService

Parameters:

name - the tag name

See Also:

BankTagsService.OPTION_ALLOW_MODIFICATIONS, BankTagsService.OPTION_HIDE_TAG_NAME

closeBankTag

public void closeBankTag()

Description copied from interface: BankTagsService

Close the currently open BankTag.

Specified by:

closeBankTag in interface BankTagsService

getActiveTag

public String getActiveTag()

Description copied from interface: BankTagsService

Get the currently active bank tag

Specified by:

getActiveTag in interface BankTagsService

Returns:

getActiveBankTag

public BankTag getActiveBankTag()

Description copied from interface: BankTagsService

Get the currently open BankTag

Specified by:

getActiveBankTag in interface BankTagsService

Returns:

getActiveLayout

public Layout getActiveLayout()

Description copied from interface: BankTagsService

Get the currently active Layout

Specified by:

getActiveLayout in interface BankTagsService

Returns:

getOptions

public int getOptions()