Eclipse Platform
Release 3.3

org.eclipse.ltk.ui.refactoring
Class TextEditChangeNode

java.lang.Object
  extended byorg.eclipse.ltk.internal.ui.refactoring.PreviewNode
      extended byorg.eclipse.ltk.internal.ui.refactoring.AbstractChangeNode
          extended byorg.eclipse.ltk.internal.ui.refactoring.InternalTextEditChangeNode
              extended byorg.eclipse.ltk.ui.refactoring.TextEditChangeNode

public class TextEditChangeNode
extends org.eclipse.ltk.internal.ui.refactoring.InternalTextEditChangeNode

A special preview node to represent TextEditBasedChanges in the preview tree.

This class should be subclassed by clients wishing to provide language aware substructures for special TextEditBasedChanges. The preview infrastructure accesses to preview node for a TextEditBasedChange by asking the change for an adapter of type TextEditChangeNode. If no adapter is returned, this default implementation will be used to present TextEditBasedChange in the preview tree.

Since:
3.2

Nested Class Summary
static class TextEditChangeNode.ChildNode
           
 
Constructor Summary
TextEditChangeNode(TextEditBasedChange change)
          Creates a new text edit change node for the given change.
 
Method Summary
protected  TextEditChangeNode.ChildNode[] createChildNodes()
           
static TextEditChangeNode.ChildNode createTextEditGroupNode(TextEditChangeNode.ChildNode parent, TextEditBasedChangeGroup changeGroup)
          Creates a new child node for the given parent and change group.
static TextEditChangeNode.ChildNode createTextEditGroupNode(TextEditChangeNode parent, TextEditBasedChangeGroup changeGroup)
          Creates a new child node for the given parent and change group.
 ImageDescriptor getImageDescriptor()
          Returns the image descriptor used to render this node in the UI.
 String getText()
          Returns the text used to render this node in the UI.
 TextEditBasedChange getTextEditBasedChange()
          Returns the TextEditBasedChange this node is associated with.
 
Methods inherited from class org.eclipse.ltk.internal.ui.refactoring.InternalTextEditChangeNode
internalGetTextEditChangeNode
 
Methods inherited from class org.eclipse.ltk.internal.ui.refactoring.AbstractChangeNode
createNode, createNode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextEditChangeNode

public TextEditChangeNode(TextEditBasedChange change)
Creates a new text edit change node for the given change.

Parameters:
change - the TextEditBasedChange this node represents in the preview tree
Method Detail

createTextEditGroupNode

public static TextEditChangeNode.ChildNode createTextEditGroupNode(TextEditChangeNode.ChildNode parent,
                                                                   TextEditBasedChangeGroup changeGroup)
Creates a new child node for the given parent and change group.

Parameters:
parent - the parent of the new child node
changeGroup - the TextEditBasedChangeGroup this child node represents in the preview tree
Returns:
the new child node

createTextEditGroupNode

public static TextEditChangeNode.ChildNode createTextEditGroupNode(TextEditChangeNode parent,
                                                                   TextEditBasedChangeGroup changeGroup)
Creates a new child node for the given parent and change group.

Parameters:
parent - the parent of the new child node
changeGroup - the TextEditBasedChangeGroup this child node represents in the preview tree
Returns:
the new child node

getTextEditBasedChange

public final TextEditBasedChange getTextEditBasedChange()
Returns the TextEditBasedChange this node is associated with.

Returns:
the TextEditBasedChange

getText

public String getText()
Returns the text used to render this node in the UI.

Returns:
a human readable representation of this node

getImageDescriptor

public ImageDescriptor getImageDescriptor()
Returns the image descriptor used to render this node in the UI.

Returns:
the image descriptor representing this node

createChildNodes

protected TextEditChangeNode.ChildNode[] createChildNodes()

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.