Package com.inductiveautomation.snap.project

Class Bookmark

  • public class Bookmark
extends java.lang.Object
    A class to represent a bookmark.

    • Constructor Summary

      Constructors 
      Constructor Description
      Bookmark​(java.lang.String aName, java.lang.String aURL)
      Creates a new bookmark.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addChild​(Bookmark aBM)
      Adds a child bookmark.
      void addChild​(Bookmark aBM, int anIndex)
      Adds a child bookmark.
      Bookmark getChild​(int anIndex)
      Returns the child bookmark at given index.
      Bookmark getChild​(java.lang.String aName, boolean goDeep)
      Returns the child with given name.
      int getChildCount()
      Returns the number of child bookmarks.
      java.util.List<Bookmark> getChildren()
      Returns the children.
      java.lang.String getName()
      Returns the name.
      Bookmark getParent()
      Returns the bookmark parent.
      WebURL getURL()
      Returns the URL.
      java.lang.String getURLString()
      Returns the URL string.
      boolean isFolder()
      Returns whether this bookmark is a folder of bookmarks.
      java.lang.Object removeChild​(int anIndex)
      Removes the child bookmark at given index.
      int removeChild​(Bookmark aBM)
      Removes the child bookmark at given index.
      void setChildren​(java.util.List<Bookmark> theBMs)
      Sets the children.
      void setFolder​(boolean aFlag)
      Sets whether this bookmark is a folder of bookmarks.
      void setName​(java.lang.String aName)
      Sets the name.
      void setURL​(WebURL aURL)
      Sets the URL.
      void setURLString​(java.lang.String aURLS)
      Sets the URL string.
      java.lang.String toString()
      Standard toString implementation.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Bookmark

        public Bookmark​(java.lang.String aName,
                java.lang.String aURL)
        Creates a new bookmark.

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name.

      • setName

        public void setName​(java.lang.String aName)
        Sets the name.

      • getURL

        public WebURL getURL()
        Returns the URL.

      • setURL

        public void setURL​(WebURL aURL)
        Sets the URL.

      • getURLString

        public java.lang.String getURLString()
        Returns the URL string.

      • setURLString

        public void setURLString​(java.lang.String aURLS)
        Sets the URL string.

      • isFolder

        public boolean isFolder()
        Returns whether this bookmark is a folder of bookmarks.

      • setFolder

        public void setFolder​(boolean aFlag)
        Sets whether this bookmark is a folder of bookmarks.

      • getParent

        public Bookmark getParent()
        Returns the bookmark parent.

      • getChildCount

        public int getChildCount()
        Returns the number of child bookmarks.

      • getChild

        public Bookmark getChild​(int anIndex)
        Returns the child bookmark at given index.

      • getChildren

        public java.util.List<Bookmark> getChildren()
        Returns the children.

      • setChildren

        public void setChildren​(java.util.List<Bookmark> theBMs)
        Sets the children.

      • addChild

        public void addChild​(Bookmark aBM)
        Adds a child bookmark.

      • addChild

        public void addChild​(Bookmark aBM,
                     int anIndex)
        Adds a child bookmark.

      • removeChild

        public java.lang.Object removeChild​(int anIndex)
        Removes the child bookmark at given index.

      • removeChild

        public int removeChild​(Bookmark aBM)
        Removes the child bookmark at given index.

      • getChild

        public Bookmark getChild​(java.lang.String aName,
                         boolean goDeep)
        Returns the child with given name.

      • toString

        public java.lang.String toString()
        Standard toString implementation.
        Overrides:
        toString in class java.lang.Object