|
Project: com.ibm.rational.teamapi.scout | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.ibm.rational.teamapi.scout.DefaultPropertySource
com.ibm.rational.teamapi.scout.ResourceSource
com.ibm.rational.teamapi.scout.ProxyElement
public class ProxyElement
A tree viewer model element for a CM API Resource. This model element also implements the IPropertySource interface so that the element selected in the tree viewer can be examined in the standard Eclipse property view.
| Nested Class Summary | |
|---|---|
(package private) static class |
ProxyElement.UnPw
A simple Authentication object in which the username and password obtained from the user is cached for use by the CM API. |
| Nested classes/interfaces inherited from class com.ibm.rational.teamapi.scout.ResourceSource |
|---|
ResourceSource.ArraySource, ResourceSource.ListSource, ResourceSource.PropertySource, ResourceSource.ResourcePropertyDescriptor |
| Field Summary | |
|---|---|
private static java.util.List<ProxyElement> |
EMPTY_ARRAY
A constant used for empty results |
private static javax.wvcm.PropertyRequestItem.PropertyRequest |
FOLDER_PROPERTIES
The properties requested from a Folder |
private static java.util.HashMap<java.lang.Object,java.lang.Object> |
g_memberListPropertyMap
|
private static java.util.Map<java.lang.Class<?>,java.lang.String> |
g_typeMap
Maps proxy classes to a string used to identify their type |
(package private) java.util.List<ProxyElement> |
m_children
The children (virtual CHILD_BINDING_LIST) of this ProxyElement. |
(package private) com.ibm.rational.wvcm.stp.StpLocation.Namespace |
m_namespace
The namespace that is being traversed through this element |
(package private) java.lang.Object |
m_parent
At the root, the CM API provider for the tree; otherwise the parent ProxyElement of this one |
private static java.lang.Object[] |
table
For each namespace, maps the proxy classes in that namespace to the property name for the property that defines the member list of that resource type in the namespace. |
| Fields inherited from class com.ibm.rational.teamapi.scout.ResourceSource |
|---|
ADVANCED_PROPERTY_FLAGS, m_descriptors, m_resource, WANTED_PROPS |
| Constructor Summary | |
|---|---|
private |
ProxyElement(ProxyElement parent,
com.ibm.rational.wvcm.stp.StpResource resource)
Constructs a model element for a given resource. |
(package private) |
ProxyElement(org.eclipse.swt.widgets.Shell shell)
Constructs the root ProxyElement of a tree view. |
| Method Summary | |
|---|---|
(package private) void |
addChild(com.ibm.rational.wvcm.stp.StpResource child)
Adds a child resource to this element of the tree view model |
(package private) void |
addChild(java.lang.String selectorString)
Adds a child resource to this element of the tree view model |
(package private) boolean |
couldBeFolder()
Determines if this model element could be a folder. |
(package private) static com.ibm.rational.wvcm.stp.StpProvider |
createProvider(org.eclipse.swt.widgets.Shell shell)
Constructs an instance of the CM API provider with an authenticator. |
(package private) java.lang.Object[] |
getChildren()
Returns the children of the resource represented by this ProxyElement; reading them from the CHILD_BINDING_LIST. |
(package private) ProxyElement |
getParent()
The ProxyElement of which this is a child. |
(package private) com.ibm.rational.wvcm.stp.StpProvider |
getProvider()
The Provider for this element of the tree. |
java.lang.String |
getSelector()
Returns the selector for this resource. |
java.lang.String |
getText()
Computes a String to identify this model element in the tree view. |
(package private) boolean |
isEmptyFolder()
Determines if this model element is an empty folder; |
(package private) boolean |
isFolder()
Determines if this model element should be considered a folder when sorting and filtering the tree view. |
(package private) boolean |
isRoot()
Returns whether or not this object is the root of the tree view. |
(package private) javax.wvcm.PropertyNameList.PropertyName |
memberListProperty(com.ibm.rational.wvcm.stp.StpResource res,
com.ibm.rational.wvcm.stp.StpLocation.Namespace namespace)
For a resource in a given namespace, returns the PropertyName that identifies the property that serves as the bound member list of that resource in the namespace. |
(package private) void |
refresh()
Empties the cache of child elements; forcing them to be reread the next time they are to be displayed. |
(package private) boolean |
removeChild(java.lang.Object child)
Removes a child model element from this model element. |
(package private) java.lang.String |
resourceType()
Returns a String suitable for displaying the type of resource as determined by its proxy class. |
java.lang.String |
toString()
(non-Javadoc) |
| Methods inherited from class com.ibm.rational.teamapi.scout.ResourceSource |
|---|
getPropertyDescriptors, getPropertyValue |
| Methods inherited from class com.ibm.rational.teamapi.scout.DefaultPropertySource |
|---|
getEditableValue, isPropertySet, resetPropertyValue, setPropertyValue |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
private static final java.util.HashMap<java.lang.Object,java.lang.Object> g_memberListPropertyMap
private static final java.lang.Object[] table
java.lang.Object m_parent
java.util.List<ProxyElement> m_children
com.ibm.rational.wvcm.stp.StpLocation.Namespace m_namespace
private static java.util.List<ProxyElement> EMPTY_ARRAY
private static final javax.wvcm.PropertyRequestItem.PropertyRequest FOLDER_PROPERTIES
private static final java.util.Map<java.lang.Class<?>,java.lang.String> g_typeMap
| Constructor Detail |
|---|
private ProxyElement(ProxyElement parent,
com.ibm.rational.wvcm.stp.StpResource resource)
parent - The parent of this element in the tree viewer. Is null
only for the (unseen) root of the tree.resource - The Resource proxy linking this element to the resource
being viewed. Must not be null except in the root
element of the tree.
ProxyElement(org.eclipse.swt.widgets.Shell shell)
throws java.lang.Exception
shell - The display shell for this ProxyElement; used for context
when requesting credentials from the user.
java.lang.Exception - if a CM API provider cannot be instantiated.| Method Detail |
|---|
void addChild(com.ibm.rational.wvcm.stp.StpResource child)
child - The Resource proxy for the new child element.
void addChild(java.lang.String selectorString)
throws javax.wvcm.WvcmException
selectorString - A String containing the object selector for the
resource to be added as a child of this element.
javax.wvcm.WvcmException - If the resource proxy can't be constructedboolean removeChild(java.lang.Object child)
child - The subordinate model element to be removed.
public java.lang.String getText()
public java.lang.String getSelector()
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()
javax.wvcm.PropertyNameList.PropertyName memberListProperty(com.ibm.rational.wvcm.stp.StpResource res,
com.ibm.rational.wvcm.stp.StpLocation.Namespace namespace)
throws javax.wvcm.WvcmException
res - namespace -
javax.wvcm.WvcmExceptionboolean couldBeFolder()
boolean isFolder()
boolean isEmptyFolder()
java.lang.Object[] getChildren()
| Repository Type | Namespace | Method |
|---|---|---|
| CLEAR_CASE | REPOSITORY | serverWorkspaceFolderList |
| CLEAR_CASE | VIEW WORKSPACE |
clientWorkspaceFolderList |
void refresh()
boolean isRoot()
ProxyElement getParent()
com.ibm.rational.wvcm.stp.StpProvider getProvider()
static com.ibm.rational.wvcm.stp.StpProvider createProvider(org.eclipse.swt.widgets.Shell shell)
throws java.lang.Exception
shell - The Shell to be used for display context when requesting
credentials.
java.lang.Exception - If the Provider could not be instantiatedjava.lang.String resourceType()
|
Generated Sun 12-Oct-2008 03:27 AM | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||