| java.lang.Object
 org.sakaiproject.tool.impl.ToolComponent
All known Subclasses: org.sakaiproject.tool.impl.ActiveToolComponent,
| ToolComponent | | abstract public class ToolComponent implements ToolManager(Code) | |
ToolComponent is the standard implementation of the Sakai Tool API.
|
| CURRENT_PLACEMENT | | final protected static String CURRENT_PLACEMENT(Code) | | Key in the ThreadLocalManager for binding our current placement.
|
| CURRENT_TOOL | | final protected static String CURRENT_TOOL(Code) | | Key in the ThreadLocalManager for binding our current tool.
|
| m_hiddenToolIds | | protected Collection m_hiddenToolIds(Code) | | tool ids to be hidden, adding to the stealth list (but not trumping the visible list)
|
| m_stealthToolIds | | protected Collection m_stealthToolIds(Code) | | tool ids to be stealthed (hidden).
|
| m_toolIdsToHide | | protected String[] m_toolIdsToHide(Code) | | tool ids to be hidden - their catagories don't matter, they don't show up on any catagorized listing.
|
| m_tools | | protected Map m_tools(Code) | | The registered tools.
|
| m_visibleToolIds | | protected Collection m_visibleToolIds(Code) | | tool ids to be visible, not hidden, even if marked hidden or stealthed.
|
| destroy | | public void destroy()(Code) | | Final cleanup.
|
| init | | public void init()(Code) | | Final initialization, once all dependencies are set.
|
| matchCriteria | | protected boolean matchCriteria(Set criteria, Set target)(Code) | | Check the target values for a match in the criteria. If criteria is empty or null, the target is a match.
Parameters:
criteria - The set of String values that is the criteria - any one in the target is a match
Parameters:
target - The set of String values to check against the criteria. true if the target meets the criteria, false if not. |
| register | | public void register(File toolXmlFile)(Code) | | |
| setCurrentPlacement | | protected void setCurrentPlacement(Placement placement)(Code) | | Establish the Tool associated with the current request / thread
Parameters:
Tool - The current Tool, or null if there is none. |
| setCurrentTool | | protected void setCurrentTool(Tool tool)(Code) | | Establish the Tool associated with the current request / thread
Parameters:
Tool - The current Tool, or null if there is none. |
| setHiddenTools | | public void setHiddenTools(String toolIds)(Code) | | Configuration - set the list of tool ids to be visible, not hidden, even if marked hidden or stealthed.
Parameters:
toolIds - The comma-separated list of tool ids to be visible. |
| setStealthTools | | public void setStealthTools(String toolIds)(Code) | | Configuration - set the list of tool ids to be "stealthed". A stealthed tool does not show up in a category list of tools.
Parameters:
toolIds - The comma-separated list of tool ids to be stealthed. |
| setVisibleTools | | public void setVisibleTools(String toolIds)(Code) | | Configuration - set the list of tool ids to be visible, not hidden, even if marked hidden or stealthed.
Parameters:
toolIds - The comma-separated list of tool ids to be visible. |
|
|