| BlueSpray - Help © SchoonerTurtles, Inc. 2012-2015
Introduction
Contents
Getting Started
Download
Navigating
Tutorials
Scripting
Advanced
About
| # Class STContent Extends STBase This is the base class for content that appears in a tree. While this is a rather large class it is also built to be lightweight and nothing is initialized unless it is needed. This class handles all inserting and deleting of content in the list and it is important that this is not violated as there is data cached based on the list to allow fast access to the list as an array. The only functions to modify the list pointers are: - InsertContentBefore(...) - InsertContentAfter(...) - InsertContentAtStart(...) - InsertContentAtEnd(...) - RemoveContent(...) The class provides the following capabilities to objects: Appear in the project tree Contain child objects Add property panels to the properties dialogs Obtain general textural information from objects Get an icon for an object's tree element Lock and unlock objects for threads to access them safely Support Drag n Drop Support selection Support popup-menus And provides the ability for objects to: Appear in the project tree Contain child objects Implementation note: This class does not use the standard java List class because it was faster and was a smaller memory foot print to implement this class as a node in a list. The list is doubly-linked and this object has pointers to the start and end of the list. Copyright, SchoonerTurtles LLP, 2009 @author Jim Graham
Returns | Default | Function | Throws
--- | --- | --- | ---
| Delete and Extensions | AddMenuItems(Container ThePopupMenu) | Exception
| null | AddSettingsPanels(STSettingsDialog TheDialog) | Exception
| Show settings dialog | DoubleClickBranch(STAppView TheView) | Exception
String |  | GetDefaultExportFileExtention() |
STBounds | 20 | GetLegendSymbolRefDimensions(STView TheView) | Exception
Image | null | GetTreeIcon(int HeightInPixels) | Exception
## Object Functions

### AddMenuItems(Container ThePopupMenu) Exception

Override this function to add additional menu items to the popup menu

Parameters:
ThePopupMenu
Returns:

### AddSettingsPanels(STSettingsDialog TheDialog) Exception

Overridden to add property panels to the properties dialog for this object.

Parameters:
TheDialog

### DoubleClickBranch(STAppView TheView) Exception

Take action based on a double click event (typically opens a new object).

Parameters:
TheView
Returns: Abort flag

### String GetDefaultExportFileExtention()

Should be overriden for items that use other file types by default (i.e. layers)

Returns:

### STBounds GetLegendSymbolRefDimensions(STView TheView) Exception

Get the height of this tree node

Returns:

### Image GetTreeIcon(int HeightInPixels) Exception

Override this function to return a specific icon for the tree for the object.
See the Document object for an example of returning an icon and the Pattern
class for an example of rendering an icon on the fly.

Returns: