Class ContextInformation

    • Constructor Detail

      • ContextInformation

        public ContextInformation​(String contextDisplayString,
                                  String informationDisplayString)
        Creates a new context information without an image.
        Parameters:
        contextDisplayString - the string to be used when presenting the context
        informationDisplayString - the string to be displayed when presenting the context information
      • ContextInformation

        public ContextInformation​(Image image,
                                  String contextDisplayString,
                                  String informationDisplayString)
        Creates a new context information with an image.
        Parameters:
        image - the image to display when presenting the context information
        contextDisplayString - the string to be used when presenting the context
        informationDisplayString - the string to be displayed when presenting the context information, may not be null
    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getImage

        public Image getImage()
        Description copied from interface: IContextInformation
        Returns the image for this context information. The image will be shown to the left of the display string.
        Specified by:
        getImage in interface IContextInformation
        Returns:
        the image to be shown or null if no image is desired
      • getContextDisplayString

        public String getContextDisplayString()
        Description copied from interface: IContextInformation
        Returns the string to be displayed in the list of contexts. This method is used to supply a unique presentation for situations where the context is ambiguous. These strings are used to allow the user to select the specific context.
        Specified by:
        getContextDisplayString in interface IContextInformation
        Returns:
        the string to be displayed for the context