t

gitbucket.core.plugin

SuggestionProvider

trait SuggestionProvider extends AnyRef

The base trait of suggestion providers which supplies completion proposals in some text areas.

Linear Supertypes
AnyRef, Any
Known Subclasses
IssueSuggestionProvider, UserNameSuggestionProvider
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SuggestionProvider
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val context: Seq[String]

    Which contexts is this suggestion provider enabled.

    Which contexts is this suggestion provider enabled. Currently, available contexts are "issues" and "wiki".

  2. abstract val id: String

    The identifier of this suggestion provider.

    The identifier of this suggestion provider. You must specify the unique identifier in the all suggestion providers.

  3. abstract val prefix: String

    The trigger of this suggestion provider.

    The trigger of this suggestion provider. When user types this character, the proposal list would be displayed. Also this is used as the prefix of the replaced string.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def additionalScript(repository: RepositoryInfo)(implicit context: Context): String

    If this suggestion provider needs some additional process to assemble the proposal list (e.g.

    If this suggestion provider needs some additional process to assemble the proposal list (e.g. It need to use Ajax to get a proposal list from the server), then override this method and return any JavaScript code.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. def options(repository: RepositoryInfo): Seq[(String, String)]

    If this suggestion provider has static proposal list, override this method to return it.

    If this suggestion provider has static proposal list, override this method to return it.

    If your proposals have label and value, use this method instead of values(). The first element of tuple is used as a value, and the second element is used as a label.

    The returned sequence is rendered as follows: 

    [
  {
    "label" -> "label1",
    "value" -> "value1"
  },
  {
    "label" -> "label2",
    "value" -> "value2"
  },
]

    Each element can be accessed as option in template() or replace() method.

  16. def replace(implicit context: Context): String

    JavaScript fragment to generate a replaced value of completion proposal.

    JavaScript fragment to generate a replaced value of completion proposal. The default is: option.value

  17. val suffix: String

    The suffix of the replaced string.

    The suffix of the replaced string. The default is " ".

  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def template(implicit context: Context): String

    JavaScript fragment to generate a label of completion proposal.

    JavaScript fragment to generate a label of completion proposal. The default is: option.label.

  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. def values(repository: RepositoryInfo): Seq[String]

    If this suggestion provider has static proposal list, override this method to return it.

    If this suggestion provider has static proposal list, override this method to return it.

    The returned sequence is rendered as follows: 

    [
  {
    "label" -> "value1",
    "value" -> "value1"
  },
  {
    "label" -> "value2",
    "value" -> "value2"
  },
]

    Each element can be accessed as option in template() or replace() method.

  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped