com.aptana.ide.editor.js.runtime
Interface IReferenceable


public interface IReferenceable

Author:
Kevin Lindsey

Method Summary
 boolean canMakeReference()
          Determine if this object can create a reference given its current state.
 Reference getReference(Environment environment, int fileIndex)
          Return a reference object that points to this command node's underlying instance.
 

Method Detail

canMakeReference

boolean canMakeReference()
Determine if this object can create a reference given its current state. In most cases, all IReferenceables will return true here. For example, GroupNodes may optionally contain a referenceable child, so in some cases, GroupNodes will not be able to return a valid Reference

Returns:
Returns true if this object can generate a valid Reference

getReference

Reference getReference(Environment environment,
                       int fileIndex)
Return a reference object that points to this command node's underlying instance. Note that most command nodes do not implement this method and therefor return null. Only commands nodes that can be used on the left side of an assignment need override this method.

Parameters:
environment - The environment to use when retrieving a reference
fileIndex - TODO
Returns:
Returns a Reference object that points to this node's underlying instance