org.netbeans.modules.xml.xam
Class AbstractComponent<C extends Component<C>>

java.lang.Object
  org.netbeans.modules.xml.xam.AbstractComponent<C>

All Implemented Interfaces:

Component<C>

Direct Known Subclasses:

AbstractDocumentComponent

public abstract class AbstractComponent<C extends Component<C>>
extends Object
implements Component<C>

An abstract implementation of the Component. It implies modification capabilities.

Constructor Summary

AbstractComponent(AbstractModel model)

Method Summary

protected void	addAfter(String propertyName, C component, Collection<Class<? extends C>> typeList) Adds a element after all other children whose types are in the typeList Collection.
protected void	addBefore(String propertyName, C component, Collection<Class<? extends C>> typeList) Adds a element before all other children whose types are in the typeList Collection.
void	addPropertyChangeListener(PropertyChangeListener pcl)
protected void	appendChild(String propertyName, C child)
protected abstract void	appendChildQuietly(C component, List<C> children)
boolean	canPaste(Component child) Default implementation, subclass need to override if needed.
void	checkChildrenPopulated() This method guarantee that children are populated.
protected void	checkNullOrDuplicateChild(C child)
protected void	fireChildAdded()
protected void	fireChildRemoved()
protected void	firePropertyChange(String propName, Object oldValue, Object newValue)
protected void	fireValueChanged()
protected <T extends C> T	getChild(Class<T> type)
List<C>	getChildren()
<T extends C> List<T>	getChildren(Class<T> type)
List<C>	getChildren(Collection<Class<? extends C>> typeList)
int	getChildrenCount() Sometimes it's necessary to know amount of children but the children themselves aren't necessary.
AbstractModel	getModel()
C	getParent()
void	insertAtIndex(String propertyName, C component, int index)
protected void	insertAtIndex(String propertyName, C component, int index, Class<? extends C> type) Inserts a Component child at the specified index relative to the provided type.
protected abstract void	insertAtIndexQuietly(C newComponent, List<C> children, int index)
protected boolean	isChildrenInitialized() This method provides the ability to detect whether calling getChildren() will trigger population of children.
protected abstract void	populateChildren(List<C> children)
void	removeChild(String propertyName, C component)
protected abstract void	removeChildQuietly(C component, List<C> children)
void	removeComponentListener(ComponentListener cl)
void	removePropertyChangeListener(PropertyChangeListener pcl)
protected void	setChild(Class<? extends C> classType, String propertyName, C newComponent, Collection<Class<? extends C>> typeList) When a child element is set using this method: (1) All children that are of the same or derived type as classType are removed.
protected void	setChild(Class<? extends C> classType, String propertyName, C newComponent, Collection<Class<? extends C>> typeList, boolean before)
protected void	setChildAfter(Class<? extends C> classType, String propertyName, C newComponent, Collection<Class<? extends C>> typeList)
protected void	setChildBefore(Class<? extends C> classType, String propertyName, C newComponent, Collection<Class<? extends C>> typeList)
protected void	setModel(AbstractModel aModel)
protected void	setParent(C component)
protected void	verifyWrite() This method ensures that a transaction is currently in progress and that the current thread is able to write the model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netbeans.modules.xml.xam.Component

copy

Constructor Detail

AbstractComponent

public AbstractComponent(AbstractModel model)

Method Detail

appendChildQuietly

protected abstract void appendChildQuietly(C component,
                                           List<C> children)

insertAtIndexQuietly

protected abstract void insertAtIndexQuietly(C newComponent,
                                             List<C> children,
                                             int index)

removeChildQuietly

protected abstract void removeChildQuietly(C component,
                                           List<C> children)

populateChildren

protected abstract void populateChildren(List<C> children)

removePropertyChangeListener

public final void removePropertyChangeListener(PropertyChangeListener pcl)

addPropertyChangeListener

public final void addPropertyChangeListener(PropertyChangeListener pcl)

removeComponentListener

public void removeComponentListener(ComponentListener cl)

getParent

public C getParent()

Specified by:

getParent in interface Component<C extends Component<C>>

Returns:

parent component.

setParent

protected void setParent(C component)

setModel

protected void setModel(AbstractModel aModel)

getChildren

public List<C> getChildren()

Specified by:

getChildren in interface Component<C extends Component<C>>

Returns:

the contained elements, this is the model element representations of the DOM children. The returned list is unmodifiable.

checkChildrenPopulated

public void checkChildrenPopulated()

This method guarantee that children are populated. It's preferable to use it instead of getChildren() if children themselves aren't necessary. This method works much faster then using getChildren() in case of big amount of children because of absence of copying children to a separate list.

Since:

1.6.1

getChildrenCount

public int getChildrenCount()

Sometimes it's necessary to know amount of children but the children themselves aren't necessary. This method works much faster then using getChildren().size() in case of big amount of children because of absence of copying children to a separate list.

Returns:

number of children

Since:

1.6.1

isChildrenInitialized

protected final boolean isChildrenInitialized()

This method provides the ability to detect whether calling getChildren() will trigger population of children. This can be used for meta models to determine whether cleanup below a set of children is necessary.

getChildren

public <T extends C> List<T> getChildren(Class<T> type)

Specified by:

getChildren in interface Component<C extends Component<C>>

Parameters:

type - Interested children type to return.

Returns:

the contained elements, this is the model element representations of the DOM children.

getChildren

public List<C> getChildren(Collection<Class<? extends C>> typeList)

Specified by:

getChildren in interface Component<C extends Component<C>>

Parameters:

typeList - Collection that accepts the interested types and filters the return list of Children.

Returns:

the contained elements, this is the model element representations of the DOM children.

getModel

public AbstractModel getModel()

Specified by:

getModel in interface Component<C extends Component<C>>

Returns:

the model where this element is being used or null if not currently part of a model.

verifyWrite

protected void verifyWrite()

This method ensures that a transaction is currently in progress and that the current thread is able to write the model.

firePropertyChange

protected void firePropertyChange(String propName,
                                  Object oldValue,
                                  Object newValue)

fireValueChanged

protected void fireValueChanged()

fireChildRemoved

protected void fireChildRemoved()

fireChildAdded

protected void fireChildAdded()

getChild

protected <T extends C> T getChild(Class<T> type)

addBefore

protected void addBefore(String propertyName,
                         C component,
                         Collection<Class<? extends C>> typeList)

Adds a element before all other children whose types are in the typeList Collection.

addAfter

protected void addAfter(String propertyName,
                        C component,
                        Collection<Class<? extends C>> typeList)

Adds a element after all other children whose types are in the typeList Collection.

checkNullOrDuplicateChild

protected void checkNullOrDuplicateChild(C child)

appendChild

protected void appendChild(String propertyName,
                           C child)

insertAtIndex

protected void insertAtIndex(String propertyName,
                             C component,
                             int index,
                             Class<? extends C> type)

Inserts a Component child at the specified index relative to the provided type. This method is expected to be used only in sequence.

Parameters:

propertyName - to fire event on

component - to insert

index - relative to first instance of type, index = firstpos

type - which index should be relative to

insertAtIndex

public void insertAtIndex(String propertyName,
                          C component,
                          int index)

removeChild

public void removeChild(String propertyName,
                        C component)

setChild

protected void setChild(Class<? extends C> classType,
                        String propertyName,
                        C newComponent,
                        Collection<Class<? extends C>> typeList)

When a child element is set using this method: (1) All children that are of the same or derived type as classType are removed. (2) newEl is added as a child after any children that are of the same type as any of the types listed in typeList

Parameters:

classType - Class of the Component that is being added as a child

propertyName - Property name used for firing events

newComponent - Component that is being added as a child

typeList - Collection of java.lang.Class-es. newEl will be added as a child after any children whose types belong to any listed in this. An empty collection will append the child

setChildAfter

protected void setChildAfter(Class<? extends C> classType,
                             String propertyName,
                             C newComponent,
                             Collection<Class<? extends C>> typeList)

setChildBefore

protected void setChildBefore(Class<? extends C> classType,
                              String propertyName,
                              C newComponent,
                              Collection<Class<? extends C>> typeList)

setChild

protected void setChild(Class<? extends C> classType,
                        String propertyName,
                        C newComponent,
                        Collection<Class<? extends C>> typeList,
                        boolean before)

canPaste

public boolean canPaste(Component child)

Default implementation, subclass need to override if needed.

Specified by:

canPaste in interface Component<C extends Component<C>>