oracle.ide.composite

Class DefaultCompositeFileElementProxy

java.lang.Object

oracle.ide.composite.BaseCompositeFileElementProxy

oracle.ide.composite.DefaultCompositeFileElementProxy

All Implemented Interfaces:

CompositeFileElementProxy

public class DefaultCompositeFileElementProxy
extends BaseCompositeFileElementProxy

The default implementation class for a CompositeFileElementProxy based on a container-style composite element type. An observer is attached to the composite elements of this proxy type to fire a composite state change event through the registry class when the container state is modified.

Constructor Summary

Constructors

Constructor and Description
DefaultCompositeFileElementProxy() Constructs a DefaultCompositeFileElementProxy object.
DefaultCompositeFileElementProxy(java.lang.Class compositeElementClass) Deprecated. replaced by DefaultCompositeFileElementProxy(); the element class is supplied in composite-file-element-hook.
DefaultCompositeFileElementProxy(java.lang.String viewType, java.lang.Class compositeElementClass) Deprecated. replaced by DefaultCompositeFileElementProxy(); the view type and element class are supplied in composite-file-element-hook.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addChildURLs(java.util.Collection compositeFileUrls, Element parent)
protected void	addLocatableURL(java.util.Collection compositeFileUrls, java.lang.Object o)
protected void	addParentURL(java.util.Collection compositeFileUrls, Element parent)
protected void	attachContainerStateObserver(Element element) Attaches a container state observer to the given element and its children.
java.lang.Class	getCompositeElementClass() Deprecated.
java.net.URL[]	getCompositeFileURLs(Element compositeElement) Gets the file URLs represented by the given composite element, attaching a container state observer to all composite children.
protected java.util.Collection	getContainerFileURLs(Element compositeElement) Gets the file URLs represented by the given composite element.
java.lang.String	getViewType() Gets the type identifier of views associated with this proxy.
protected boolean	isContainerStyleRecursive() Asks whether this proxy behaves recursively with respect to its composite elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCompositeFileElementProxy

public DefaultCompositeFileElementProxy()

Constructs a DefaultCompositeFileElementProxy object.

DefaultCompositeFileElementProxy

@Deprecated
public DefaultCompositeFileElementProxy(java.lang.Class compositeElementClass)

Deprecated. replaced by DefaultCompositeFileElementProxy(); the element class is supplied in composite-file-element-hook.

Constructs a DefaultCompositeFileElementProxy object.

Parameters:

compositeElementClass - the class of composite elements for the proxy.

DefaultCompositeFileElementProxy

@Deprecated
public DefaultCompositeFileElementProxy(java.lang.String viewType,
                                           java.lang.Class compositeElementClass)

Deprecated. replaced by DefaultCompositeFileElementProxy(); the view type and element class are supplied in composite-file-element-hook.

Constructs a DefaultCompositeFileElementProxy object.

Parameters:

viewType - the type of views associated with this proxy.

compositeElementClass - the class of composite elements for the proxy.

Method Detail

getViewType

public java.lang.String getViewType()

Gets the type identifier of views associated with this proxy. A view type of null indicates any potential view.

Overrides:

getViewType in class BaseCompositeFileElementProxy

Returns:

the view type.

getCompositeElementClass

@Deprecated
public java.lang.Class getCompositeElementClass()

Deprecated.

Gets the composite element class handled by this proxy. By default, returns the class with which this proxy instance was constructed.

Specified by:

getCompositeElementClass in interface CompositeFileElementProxy

Overrides:

getCompositeElementClass in class BaseCompositeFileElementProxy

Returns:

the composite element class.

getCompositeFileURLs

public java.net.URL[] getCompositeFileURLs(Element compositeElement)

Gets the file URLs represented by the given composite element, attaching a container state observer to all composite children.

Parameters:

compositeElement - the composite element.

Returns:

the composite file URLs.

attachContainerStateObserver

protected void attachContainerStateObserver(Element element)

Attaches a container state observer to the given element and its children.

Parameters:

element - the element.

getContainerFileURLs

protected java.util.Collection getContainerFileURLs(Element compositeElement)

Gets the file URLs represented by the given composite element. By default, this includes all child elements that implement the Locatable interface and the element itself, if also a Locatable.

Parameters:

compositeElement - the composite element.

Returns:

the composite file URLs.

isContainerStyleRecursive

protected boolean isContainerStyleRecursive()

Asks whether this proxy behaves recursively with respect to its composite elements. By default, returns true.

Returns:

a verdict on recursive container behavior.

addParentURL

protected void addParentURL(java.util.Collection compositeFileUrls,
                Element parent)

addChildURLs

protected void addChildURLs(java.util.Collection compositeFileUrls,
                Element parent)

addLocatableURL

protected void addLocatableURL(java.util.Collection compositeFileUrls,
                   java.lang.Object o)