Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


org.eclipse.jet.taglib
Class MarkerHelper

java.lang.Object
  extended by 
org.eclipse.jet.taglib.MarkerHelper
All Implemented Interfaces:
IWriterListener

public class MarkerHelper
extends java.lang.Object
implements IWriterListener

Helper for implementing task markers on writer output.


Method Summary
static void createMarkerOnWriter ( JET2Writer writer, int start, int end, java.lang.String description, TagInfo tagInfo, java.lang.String templatePath)
          Specify a region of the writer that will become a workspace marker when the file contents are committed.
 void finalizeContent ( JET2Writer writer, java.lang.Object file)
          Perform any finalization of the content in the writer.
 void postCommitContent ( JET2Writer writer, java.lang.Object file)
          Perform any post processing on the committed file based on content written.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

finalizeContent

public void finalizeContent(
JET2Writer writer,
                            java.lang.Object file)
                     throws 
JET2TagException
Description copied from interface: IWriterListener
Perform any finalization of the content in the writer.

Specified by:
finalizeContent in interface IWriterListener
Parameters:
writer - the writer in the process of being finalized
file - a handle to object to which the content will ultimately be written. The standard JET2 Workspace tags pass an org.eclipse.core.resources.IFile, but other tags may pass objects of other types.
Throws:
JET2TagException - if the method cannot complete normally

postCommitContent

public void postCommitContent(
JET2Writer writer,
                              java.lang.Object file)
                       throws 
JET2TagException
Description copied from interface: IWriterListener
Perform any post processing on the committed file based on content written.

Specified by:
postCommitContent in interface IWriterListener
Parameters:
writer - the writer that provided the committed content.
file - a handle to the object containing the comitted content. The standard JET2 Workspace tags pass an org.eclipse.core.resources.IFile, but other tags may pass objects of other types.
Throws:
JET2TagException - if method cannot complete normally.

createMarkerOnWriter

public static void createMarkerOnWriter(
JET2Writer writer,
                                        int start,
                                        int end,
                                        java.lang.String description,
                                        
TagInfo tagInfo,
                                        java.lang.String templatePath)
Specify a region of the writer that will become a workspace marker when the file contents are committed.

Parameters:
writer - the current writter
start - the start offset of the marker within the current buffer
end - the offset of the first character after the marker
description - the marker descrpition
tagInfo - the tag information of the tag creating the marker. May be null
templatePath - the path of the currently executing template. May be null.
Throws:
java.lang.IllegalArgumentException - if writer is not a BufferedJET2Writer, or if start and end are not with in the writer contents.

Copyright 2006 IBM Corporation and others.
All Rights Reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire