alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/*
 * FoldHandler.java - Fold handler interface
 * :tabSize=8:indentSize=8:noTabs=false:
 * :folding=explicit:collapseFolds=1:
 *
 * Copyright (C) 2001, 2003 Slava Pestov
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package org.gjt.sp.jedit.buffer;

import java.util.*;
import javax.swing.text.Segment;
import org.gjt.sp.jedit.Buffer;
import org.gjt.sp.jedit.MiscUtilities;
import org.gjt.sp.jedit.ServiceManager;
import org.gjt.sp.util.Log;

/**
 * Interface for obtaining the fold level of a specified line.

* * Plugins can provide fold handlers by defining entries in their * services.xml files like so: * *

<SERVICE CLASS="org.gjt.sp.jedit.buffer.FoldHandler" NAME="name">
 *    new MyFoldHandler();
 *</SERVICE>
* * See {@link org.gjt.sp.jedit.ServiceManager} for details. * * @author Slava Pestov * @version $Id: FoldHandler.java,v 1.14 2003/11/18 20:51:57 spestov Exp $ * @since jEdit 4.0pre1 */ public abstract class FoldHandler { /** * The service type. See {@link org.gjt.sp.jedit.ServiceManager}. * @since jEdit 4.2pre1 */ public static final String SERVICE = "org.gjt.sp.jedit.buffer.FoldHandler"; //{{{ getName() method /** * Returns the internal name of this FoldHandler * @return The internal name of this FoldHandler * @since jEdit 4.0pre6 */ public String getName() { return name; } //}}} //{{{ getFoldLevel() method /** * Returns the fold level of the specified line. * @param buffer The buffer in question * @param lineIndex The line index * @param seg A segment the fold handler can use to obtain any * text from the buffer, if necessary * @return The fold level of the specified line * @since jEdit 4.0pre1 */ public abstract int getFoldLevel(Buffer buffer, int lineIndex, Segment seg); //}}} //{{{ equals() method /** * Returns if the specified fold handler is equal to this one. * @param o The object */ public boolean equals(Object o) { // Default implementation... subclasses can extend this. if(o == null) return false; else return getClass() == o.getClass(); } //}}} //{{{ hashCode() method public int hashCode() { return getClass().hashCode(); } //}}} //{{{ registerFoldHandler() method /** * @deprecated Write a services.xml file instead; * see {@link org.gjt.sp.jedit.ServiceManager}. */ public static void registerFoldHandler(FoldHandler handler) { if (getFoldHandler(handler.getName()) != null) { Log.log(Log.ERROR, FoldHandler.class, "Cannot register more than one fold handler with the same name"); return; } foldHandlers.add(handler); } //}}} //{{{ unregisterFoldHandler() method /** * @deprecated Write a services.xml file instead; * see {@link org.gjt.sp.jedit.ServiceManager}. */ public static void unregisterFoldHandler(FoldHandler handler) { foldHandlers.remove(handler); } //}}} //{{{ getFoldHandlers() method /** * @deprecated Call * ServiceManager.getServiceNames( * "org.gjt.sp.jedit.buffer.FoldHandler" ); instead. See * {@link org.gjt.sp.jedit.ServiceManager}. */ public static FoldHandler[] getFoldHandlers() { FoldHandler[] handlers = new FoldHandler[foldHandlers.size()]; return (FoldHandler[])foldHandlers.toArray(handlers); } //}}} //{{{ getFoldHandler() method /** * Returns the fold handler with the specified name, or null if * there is no registered handler with that name. * @param name The name of the desired fold handler * @since jEdit 4.0pre6 */ public static FoldHandler getFoldHandler(String name) { FoldHandler handler = (FoldHandler)ServiceManager .getService(SERVICE,name); if(handler != null) return handler; Iterator i = foldHandlers.iterator(); while (i.hasNext()) { handler = (FoldHandler)i.next(); if (name.equals(handler.getName())) return handler; } return null; } //}}} //{{{ getFoldModes() method /** * Returns an array containing the names of all registered fold * handlers. * * @since jEdit 4.0pre6 */ public static String[] getFoldModes() { FoldHandler[] handlers = getFoldHandlers(); String[] newApi = ServiceManager.getServiceNames(SERVICE); String[] foldModes = new String[handlers.length + newApi.length]; System.arraycopy(newApi,0,foldModes,0,newApi.length); for (int i = 0; i < handlers.length; i++) { foldModes[i + newApi.length] = handlers[i].getName(); } Arrays.sort(foldModes,new MiscUtilities.StringCompare()); return foldModes; } //}}} //{{{ FoldHandler() constructor protected FoldHandler(String name) { this.name = name; } //}}} //{{{ toString() method public String toString() { return name; } //}}} //{{{ Private members private String name; /** * @deprecated */ private static ArrayList foldHandlers; //}}} //{{{ Static initializer static { foldHandlers = new ArrayList(); } //}}} }
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.