Package org.dreambot.api.methods.tabs

Class Tabs

  • public class Tabs
extends java.lang.Object

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static @Nullable Tab getOpen()
      Gets the currently open tab
      static boolean isDisabled​(@NonNull Tab tab)
      Checks if the tab is disabled.
      static boolean isOpen​(@NonNull Tab tab)
      Checks if tab is open
      static void logout()
      Opens logout tab and clicks logout button
      static boolean open​(@NonNull Tab tab)
      Opens specified tab
      static boolean openWithFKey​(@NonNull Tab tab)
      Opens the tab using F keys.
      static boolean openWithMouse​(@NonNull Tab tab)
      Opens the tab using the mouse.
      static void setShouldUseFKey​(@Nullable java.util.function.Predicate<Tab> shouldUseFKey)
      Sets the strategy for determining whether to use keyboard F-keys or mouse clicks to open tabs

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • isOpen

        public static boolean isOpen​(@NonNull Tab tab)
        Checks if tab is open
        Parameters:
        tab - Tab to check
        Returns:
        True if open, else False

      • getOpen

        public static @Nullable Tab getOpen()
        Gets the currently open tab
        Returns:
        Tab that is currently open

      • open

        public static boolean open​(@NonNull Tab tab)
        Opens specified tab
        Parameters:
        tab - Tab to open
        Returns:
        True if tab is opened, else False

      • openWithFKey

        public static boolean openWithFKey​(@NonNull Tab tab)
        Opens the tab using F keys. NOTE: DOESN'T WORK WITH LOGOUT TAB.
        Parameters:
        tab - Tab to open
        Returns:
        Whether tab was successfully opened or not.

      • openWithMouse

        public static boolean openWithMouse​(@NonNull Tab tab)
        Opens the tab using the mouse.
        Parameters:
        tab - Tab to open.
        Returns:
        Whether tab was successfully opened or not.

      • isDisabled

        public static boolean isDisabled​(@NonNull Tab tab)
        Checks if the tab is disabled.
        Parameters:
        tab - Tab to check
        Returns:
        True if disabled, else False

      • logout

        public static void logout()
        Opens logout tab and clicks logout button

      • setShouldUseFKey

        public static void setShouldUseFKey​(@Nullable java.util.function.Predicate<Tab> shouldUseFKey)
        Sets the strategy for determining whether to use keyboard F-keys or mouse clicks to open tabs

        Note that this is ignored if an item or spell is selected, in which case we'll always attempt the F-key first

        Parameters:
        shouldUseFKey - predicate that returns true if it should be opened using the F-key, false for mouse Pass null to reset to the default (using the F-key if the mouse is far from the tab)