| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.4.2_05) on Fri Aug 12 09:39:09 BST 2005 --> |
| <TITLE> |
| Stripe |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.contribution.visualiser.core.Stripe class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="Stripe"; |
| } |
| </SCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Stripe.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/contribution/visualiser/core/RendererManager.html" title="class in org.eclipse.contribution.visualiser.core"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Stripe.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.contribution.visualiser.core</FONT> |
| <BR> |
| Class Stripe</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.eclipse.contribution.visualiser.core.Stripe</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Comparable</DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/eclipse/contribution/visualiser/markerImpl/MarkerMarkupProvider.StripeWithMarker.html" title="class in org.eclipse.contribution.visualiser.markerImpl">MarkerMarkupProvider.StripeWithMarker</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>Stripe</B><DT>extends java.lang.Object<DT>implements java.lang.Comparable</DL> |
| |
| <P> |
| The stripe class represents a mark on a bar, stripes can be any depth and be |
| of multiple 'kinds' (kinds map to colors). |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#Stripe()">Stripe</A></B>()</CODE> |
| |
| <BR> |
| Default constructor</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#Stripe(org.eclipse.contribution.visualiser.interfaces.IMarkupKind, int)">Stripe</A></B>(<A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IMarkupKind.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IMarkupKind</A> k, |
| int i)</CODE> |
| |
| <BR> |
| Stripe constructor when the stripe is of the minimum depth (1).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#Stripe(org.eclipse.contribution.visualiser.interfaces.IMarkupKind, int, int)">Stripe</A></B>(<A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IMarkupKind.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IMarkupKind</A> k, |
| int o, |
| int d)</CODE> |
| |
| <BR> |
| Stripe constructor where the kind, offset and depth can be specified.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#Stripe(java.util.List, int, int)">Stripe</A></B>(java.util.List ks, |
| int o, |
| int d)</CODE> |
| |
| <BR> |
| Stripe constructor where the kinds, offset and depth can be specified.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#addKinds(java.util.List)">addKinds</A></B>(java.util.List list)</CODE> |
| |
| <BR> |
| Add the given kinds to this stripe</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#compareTo(java.lang.Object)">compareTo</A></B>(java.lang.Object other)</CODE> |
| |
| <BR> |
| Compare this Stripe to another Object, which should be a Stripe.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object that)</CODE> |
| |
| <BR> |
| Returns true if the given Object is equal to this stripe</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#getDepth()">getDepth</A></B>()</CODE> |
| |
| <BR> |
| Get this Stripe's depth</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#getKinds()">getKinds</A></B>()</CODE> |
| |
| <BR> |
| Getter for the kinds of this stripe.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#getOffset()">getOffset</A></B>()</CODE> |
| |
| <BR> |
| Get the offset for this Stripe</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#getToolTip()">getToolTip</A></B>()</CODE> |
| |
| <BR> |
| Get the tooltip for this Stripe, which is a list of its kinds</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#hashCode()">hashCode</A></B>()</CODE> |
| |
| <BR> |
| Override hashCode because we have overridden equals.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#hasKind(org.eclipse.contribution.visualiser.interfaces.IMarkupKind)">hasKind</A></B>(<A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IMarkupKind.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IMarkupKind</A> kind)</CODE> |
| |
| <BR> |
| Returns true if this Stripe has the given kind</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#setDepth(int)">setDepth</A></B>(int i)</CODE> |
| |
| <BR> |
| Set the depth for this Stripe</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#setKinds(java.util.List)">setKinds</A></B>(java.util.List list)</CODE> |
| |
| <BR> |
| Set the list of kinds for this Stripe to the given argument</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#setOffset(int)">setOffset</A></B>(int offset)</CODE> |
| |
| <BR> |
| Set the offset for this Stripe</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#stringifyKinds()">stringifyKinds</A></B>()</CODE> |
| |
| <BR> |
| Get a string representation of the kinds in this Stripe</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/contribution/visualiser/core/Stripe.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| Get a String representation of this Stripe</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="Stripe()"><!-- --></A><H3> |
| Stripe</H3> |
| <PRE> |
| public <B>Stripe</B>()</PRE> |
| <DL> |
| <DD>Default constructor |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="Stripe(org.eclipse.contribution.visualiser.interfaces.IMarkupKind, int)"><!-- --></A><H3> |
| Stripe</H3> |
| <PRE> |
| public <B>Stripe</B>(<A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IMarkupKind.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IMarkupKind</A> k, |
| int i)</PRE> |
| <DL> |
| <DD>Stripe constructor when the stripe is of the minimum depth (1). |
| <P> |
| <DT><B>Parameters:</B><DD><CODE>k</CODE> - The kind of stripe<DD><CODE>i</CODE> - The offset down the bar where the stripe starts</DL> |
| <HR> |
| |
| <A NAME="Stripe(org.eclipse.contribution.visualiser.interfaces.IMarkupKind, int, int)"><!-- --></A><H3> |
| Stripe</H3> |
| <PRE> |
| public <B>Stripe</B>(<A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IMarkupKind.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IMarkupKind</A> k, |
| int o, |
| int d)</PRE> |
| <DL> |
| <DD>Stripe constructor where the kind, offset and depth can be specified. |
| <P> |
| <DT><B>Parameters:</B><DD><CODE>k</CODE> - The kind of the stripe<DD><CODE>o</CODE> - The offset down the bar where the stripe starts<DD><CODE>d</CODE> - The depth of the stripe</DL> |
| <HR> |
| |
| <A NAME="Stripe(java.util.List, int, int)"><!-- --></A><H3> |
| Stripe</H3> |
| <PRE> |
| public <B>Stripe</B>(java.util.List ks, |
| int o, |
| int d)</PRE> |
| <DL> |
| <DD>Stripe constructor where the kinds, offset and depth can be specified. |
| The input list 'kinds' should be a list of strings. |
| <P> |
| <DT><B>Parameters:</B><DD><CODE>ks</CODE> - The kinds of the stripe, should be strings<DD><CODE>o</CODE> - The offset down the bar where the stripe starts<DD><CODE>d</CODE> - The depth of the stripe</DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="equals(java.lang.Object)"><!-- --></A><H3> |
| equals</H3> |
| <PRE> |
| public boolean <B>equals</B>(java.lang.Object that)</PRE> |
| <DL> |
| <DD>Returns true if the given Object is equal to this stripe |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>that</CODE> - |
| <DT><B>Returns:</B><DD>true iff the given Object is equal to this stripe</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hashCode()"><!-- --></A><H3> |
| hashCode</H3> |
| <PRE> |
| public int <B>hashCode</B>()</PRE> |
| <DL> |
| <DD>Override hashCode because we have overridden equals. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKinds()"><!-- --></A><H3> |
| getKinds</H3> |
| <PRE> |
| public java.util.List <B>getKinds</B>()</PRE> |
| <DL> |
| <DD>Getter for the kinds of this stripe. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>List of strings representing kinds</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addKinds(java.util.List)"><!-- --></A><H3> |
| addKinds</H3> |
| <PRE> |
| public void <B>addKinds</B>(java.util.List list)</PRE> |
| <DL> |
| <DD>Add the given kinds to this stripe |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>list</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setKinds(java.util.List)"><!-- --></A><H3> |
| setKinds</H3> |
| <PRE> |
| public void <B>setKinds</B>(java.util.List list)</PRE> |
| <DL> |
| <DD>Set the list of kinds for this Stripe to the given argument |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>list</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOffset()"><!-- --></A><H3> |
| getOffset</H3> |
| <PRE> |
| public int <B>getOffset</B>()</PRE> |
| <DL> |
| <DD>Get the offset for this Stripe |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the offset for this Stripe</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDepth()"><!-- --></A><H3> |
| getDepth</H3> |
| <PRE> |
| public int <B>getDepth</B>()</PRE> |
| <DL> |
| <DD>Get this Stripe's depth |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>this Stripe's depth</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public java.lang.String <B>toString</B>()</PRE> |
| <DL> |
| <DD>Get a String representation of this Stripe |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="stringifyKinds()"><!-- --></A><H3> |
| stringifyKinds</H3> |
| <PRE> |
| public java.lang.String <B>stringifyKinds</B>()</PRE> |
| <DL> |
| <DD>Get a string representation of the kinds in this Stripe |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a string representation of the kinds in this Stripe</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOffset(int)"><!-- --></A><H3> |
| setOffset</H3> |
| <PRE> |
| public void <B>setOffset</B>(int offset)</PRE> |
| <DL> |
| <DD>Set the offset for this Stripe |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>offset</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDepth(int)"><!-- --></A><H3> |
| setDepth</H3> |
| <PRE> |
| public void <B>setDepth</B>(int i)</PRE> |
| <DL> |
| <DD>Set the depth for this Stripe |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>i</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getToolTip()"><!-- --></A><H3> |
| getToolTip</H3> |
| <PRE> |
| public java.lang.String <B>getToolTip</B>()</PRE> |
| <DL> |
| <DD>Get the tooltip for this Stripe, which is a list of its kinds |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasKind(org.eclipse.contribution.visualiser.interfaces.IMarkupKind)"><!-- --></A><H3> |
| hasKind</H3> |
| <PRE> |
| public boolean <B>hasKind</B>(<A HREF="../../../../../org/eclipse/contribution/visualiser/interfaces/IMarkupKind.html" title="interface in org.eclipse.contribution.visualiser.interfaces">IMarkupKind</A> kind)</PRE> |
| <DL> |
| <DD>Returns true if this Stripe has the given kind |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>kind</CODE> - |
| <DT><B>Returns:</B><DD>true iff this Stripe has the given kind</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3> |
| compareTo</H3> |
| <PRE> |
| public int <B>compareTo</B>(java.lang.Object other)</PRE> |
| <DL> |
| <DD>Compare this Stripe to another Object, which should be a Stripe. Returns |
| -1 if this stripe is considered less than the argument, 0 if the are |
| considered equal and 1 if this Stripe is greater than the argument |
| Stripe. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable</CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Stripe.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/contribution/visualiser/core/RendererManager.html" title="class in org.eclipse.contribution.visualiser.core"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Stripe.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
