jhelp.util.gui

Class JHelpRichText.Symbol

java.lang.Object

jhelp.util.gui.JHelpRichText.Symbol

All Implemented Interfaces:

java.lang.Comparable<JHelpRichText.Symbol>

Enclosing class:

JHelpRichText

private static class JHelpRichText.Symbol
extends java.lang.Object
implements java.lang.Comparable<JHelpRichText.Symbol>

Represents an association between a symbol (For example :) ) and an image

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	resource Image resource name
private java.lang.String	symbol Symbol associated

Constructor Summary

Constructors

Constructor and Description
JHelpRichText.Symbol(java.lang.String symbol, java.lang.String resource) Create a new instance of Symbol

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(JHelpRichText.Symbol symbol) Compare with an other symbol.
java.lang.String	getResource() Image resource name associated
java.lang.String	getSymbol() Associated symbol
java.lang.String	toString() String representation Parent documentation:

Methods inherited from class java.lang.Object

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

Field Detail

resource

private final java.lang.String resource

Image resource name

symbol

private final java.lang.String symbol

Symbol associated

Constructor Detail

JHelpRichText.Symbol

public JHelpRichText.Symbol(java.lang.String symbol,
                    java.lang.String resource)

Create a new instance of Symbol

Parameters:

symbol - The symbol

resource - Image resource name

Method Detail

compareTo

public int compareTo(JHelpRichText.Symbol symbol)

Compare with an other symbol.
It returns :

• < 0 : if this symbol is before the given one
• 0 : if the compared symbol is the same
• > 0 : if this symbol is after the given one

Parent documentation:

Specified by:

compareTo in interface java.lang.Comparable<JHelpRichText.Symbol>

Parameters:

symbol - Symbol to compare

Returns:

Comparison result

See Also:

Comparable.compareTo(java.lang.Object)

getResource

public java.lang.String getResource()

Image resource name associated

Returns:

Image resource name associated

getSymbol

public java.lang.String getSymbol()

Associated symbol

Returns:

Associated symbol

toString

public java.lang.String toString()

String representation

Parent documentation:

Overrides:

toString in class java.lang.Object

Returns:

String representation

See Also:

Object.toString()