org.itsnat.comp.inc

Interface ItsNatInclude

All Superinterfaces:

ItsNatComponent, ItsNatElementComponent, ItsNatUserData

All Known Subinterfaces:

ItsNatFreeInclude

public interface ItsNatInclude
extends ItsNatElementComponent

Is the base interface of "include" components. A "include" is used to insert/remove dynamically a markup fragment below the associated DOM element of the component.

Only a free version is defined.

Author:

Jose Maria Arranz Santamaria

Method Summary

Methods

Modifier and Type	Method and Description
String	getIncludedFragmentName() Returns the name of the current included fragment.
void	includeFragment(String name) Includes a new markup fragment.
void	includeFragment(String name, boolean buildComp) Includes a new markup fragment.
boolean	isIncluded() Informs whether a fragment was inserted using this component.
void	removeFragment() Removes the current included markup fragment.

Methods inherited from interface org.itsnat.comp.ItsNatElementComponent

getElement, getItsNatElementComponentUI

Methods inherited from interface org.itsnat.comp.ItsNatComponent

addEventListener, addEventListener, addEventListener, addEventListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, disableEventListener, disableEventListener, dispose, enableEventListener, enableEventListener, getArtifact, getArtifact, getItsNatComponentManager, getItsNatComponentUI, getItsNatDocument, getNode, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, isDisposed, isEnabled, registerArtifact, removeArtifact, removeEventListener, removeEventListener, removeEventListener, removeEventListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, setEnabled, setEventListenerParams, setEventListenerParams, setNode

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

isIncluded

boolean isIncluded()

Informs whether a fragment was inserted using this component.

Returns:

true if a fragment was inserted.

See Also:

includeFragment(String,boolean)

getIncludedFragmentName

String getIncludedFragmentName()

Returns the name of the current included fragment.

Returns:

the name of the current included fragment. Null if no fragment was inserted.

See Also:

includeFragment(String,boolean)

includeFragment

void includeFragment(String name,
                   boolean buildComp)

Includes a new markup fragment. If a fragment was included before then is removed first.

Parameters:

name - the name of the markup fragment to insert.

buildComp - if true markup defined components are automatically built.

See Also:

removeFragment(), ItsNatComponentManager.buildItsNatComponents(Node)

includeFragment

void includeFragment(String name)

Includes a new markup fragment. If a fragment was included before then is removed first. No markup defined components are automatically built .

Parameters:

name - the name of the markup fragment to insert.

See Also:

includeFragment(String,boolean)

removeFragment

void removeFragment()

Removes the current included markup fragment. If no fragment was included nothing is done.

See Also:

includeFragment(String,boolean)