sidekick
Interface IAsset

All Known Implementing Classes:
Asset, SideKickAsset, SourceAsset

public interface IAsset

A block of code within a file. Assets correspond to nodes in the Structure Browser and folds in the SideKick folding mode.


Method Summary
 javax.swing.text.Position getEnd()
          Returns the end position.
 javax.swing.Icon getIcon()
          Returns the icon to be shown for the asset in the structure tree.
 java.lang.String getLongString()
          Returns a full description of the asset to be shown in the view's status bar on when the mouse is over the asset in the tree.
 java.lang.String getName()
          Returns the name of the Asset.
 java.lang.String getShortString()
          Returns a brief description of the asset to be shown in the tree.
 javax.swing.text.Position getStart()
          Returns the starting position.
 void setEnd(javax.swing.text.Position end)
          Set the end position
 void setName(java.lang.String name)
          Set the name of the asset
 void setStart(javax.swing.text.Position start)
          Set the start position
 

Method Detail

getIcon

javax.swing.Icon getIcon()
Returns the icon to be shown for the asset in the structure tree.


getShortString

java.lang.String getShortString()
Returns a brief description of the asset to be shown in the tree. This string is displayed in the jEdit status bar and optionally in a tool tip (if the user has the 'show tool tips' option turned on).


getLongString

java.lang.String getLongString()
Returns a full description of the asset to be shown in the view's status bar on when the mouse is over the asset in the tree. Only the first line of this message will be shown in the status bar. The full text will be displayed in the built-in status window (if the user has the 'show status window' option turned on).


getName

java.lang.String getName()
Returns the name of the Asset.


setName

void setName(java.lang.String name)
Set the name of the asset


setStart

void setStart(javax.swing.text.Position start)
Set the start position


getStart

javax.swing.text.Position getStart()
Returns the starting position.


setEnd

void setEnd(javax.swing.text.Position end)
Set the end position


getEnd

javax.swing.text.Position getEnd()
Returns the end position.