Package org.fife.rsta.ac.java

Class ClassCompletion

java.lang.Object
org.fife.ui.autocomplete.AbstractCompletion
org.fife.ui.autocomplete.BasicCompletion
org.fife.rsta.ac.java.AbstractJavaSourceCompletion
org.fife.rsta.ac.java.ClassCompletion
All Implemented Interfaces:
Comparable<org.fife.ui.autocomplete.Completion>, JavaSourceCompletion, org.fife.ui.autocomplete.Completion
class ClassCompletion extends AbstractJavaSourceCompletion
Completion for a Java class, interface or enum.
Version:
1.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private ClassFile
    cf
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClassCompletion(org.fife.ui.autocomplete.CompletionProvider provider, ClassFile cf)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(org.fife.ui.autocomplete.Completion c2)
    Overridden to ensure that two completions don't just have the same text value (ignoring case), but that they're of the same "type" of Completion as well, so, for example, a completion for the "String" class won't clash with a completion for a "string" LocalVar.
    boolean
    equals(Object obj)
    Force subclasses to override equals().
    String
    getClassName(boolean fullyQualified)
    Returns the name of the class represented by this completion.
    Icon
    getIcon()
     
    String
    getPackageName()
    Returns the package this class or interface is in.
    String
    getSummary()
     
    String
    getToolTipText()
     
    int
    hashCode()
     
    void
    rendererText(Graphics g, int x, int y, boolean selected)
    Used by JavaCellRenderer to render this completion choice.

    Methods inherited from class org.fife.rsta.ac.java.AbstractJavaSourceCompletion

    getAlreadyEntered

    Methods inherited from class org.fife.ui.autocomplete.BasicCompletion

    getReplacementText, getShortDescription, setShortDescription, setSummary, toString

    Methods inherited from class org.fife.ui.autocomplete.AbstractCompletion

    getInputText, getProvider, getRelevance, setIcon, setRelevance

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.fife.ui.autocomplete.Completion

    getInputText, getProvider, getRelevance, getReplacementText

  • Field Details

  • Constructor Details

    • ClassCompletion

      ClassCompletion(org.fife.ui.autocomplete.CompletionProvider provider, ClassFile cf)

  • Method Details

    • compareTo

      public int compareTo(org.fife.ui.autocomplete.Completion c2)
      Description copied from class: AbstractJavaSourceCompletion
      Overridden to ensure that two completions don't just have the same text value (ignoring case), but that they're of the same "type" of Completion as well, so, for example, a completion for the "String" class won't clash with a completion for a "string" LocalVar.
      Specified by:
      compareTo in interface Comparable<org.fife.ui.autocomplete.Completion>
      Specified by:
      compareTo in interface org.fife.ui.autocomplete.Completion
      Overrides:
      compareTo in class AbstractJavaSourceCompletion
      Parameters:
      c2 - Another completion instance.
      Returns:
      How this completion compares to the other one.

    • equals

      public boolean equals(Object obj)
      Description copied from interface: JavaSourceCompletion
      Force subclasses to override equals(). TODO: Remove me
      Specified by:
      equals in interface JavaSourceCompletion
      Overrides:
      equals in class Object

    • getClassName

      public String getClassName(boolean fullyQualified)
      Returns the name of the class represented by this completion.
      Parameters:
      fullyQualified - Whether the returned name should be fully qualified.
      Returns:
      The class name.
      See Also:

    • getIcon

      public Icon getIcon()
      Specified by:
      getIcon in interface org.fife.ui.autocomplete.Completion
      Overrides:
      getIcon in class org.fife.ui.autocomplete.AbstractCompletion

    • getPackageName

      public String getPackageName()
      Returns the package this class or interface is in.
      Returns:
      The package, or null if it is not in a package.
      See Also:

    • getSummary

      public String getSummary()
      Specified by:
      getSummary in interface org.fife.ui.autocomplete.Completion
      Overrides:
      getSummary in class org.fife.ui.autocomplete.BasicCompletion

    • getToolTipText

      public String getToolTipText()
      Specified by:
      getToolTipText in interface org.fife.ui.autocomplete.Completion
      Overrides:
      getToolTipText in class org.fife.ui.autocomplete.AbstractCompletion

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • rendererText

      public void rendererText(Graphics g, int x, int y, boolean selected)
      Description copied from interface: JavaSourceCompletion
      Used by JavaCellRenderer to render this completion choice.
      Parameters:
      g - The graphics context to render to.
      x - The x-offset at which to render.
      y - The y-offset at which to render.
      selected - Whether this completion is currently selected/active.