org.itsnat.comp

Interface ItsNatComponentManager

All Known Subinterfaces:

ItsNatHTMLComponentManager

public interface ItsNatComponentManager

Utility interface to manage (create, register etc) ItsNat components of the associated ItsNatDocument.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatDocument.getItsNatComponentManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCreateItsNatComponentListener(CreateItsNatComponentListener listener) Adds a new user defined component factory.
void	addExcludedNodeAsItsNatComponent(Node node) Registers the specified node in the excluded registry.
ItsNatComponent	addItsNatComponent(ItsNatComponent comp) Adds to the manager registry the specified component object.
ItsNatComponent	addItsNatComponent(Node node) Creates and adds to the manager registry a new component object associated to the specified node.
ItsNatComponent	addItsNatComponent(Node node, String compType, NameValue[] artifacts) Creates and adds to the manager registry a new component object associated to the specified node.
ItsNatComponent	addItsNatComponentById(String id) Creates and adds to the manager registry a new component object associated to the node with the specified id attribute.
ItsNatComponent	addItsNatComponentById(String id, String compType, NameValue[] artifacts) Creates and adds to the manager registry a new component object associated to the node with the specified id attribute.
ItsNatComponent[]	buildItsNatComponents() Navigates recursively the document tree and for every node tries to create and register the built-in component associated to the node.
ItsNatComponent[]	buildItsNatComponents(Node node) Navigates recursively the subtree below the specified node (included) and for every node tries to create and register the built-in component associated to the node.
ItsNatLabelEditor	createDefaultItsNatLabelEditor(ItsNatComponent compEditor) Creates a default label editor instance using the specified component as the editor.
ItsNatLabelRenderer	createDefaultItsNatLabelRenderer() Creates a new default label renderer.
ItsNatListCellEditor	createDefaultItsNatListCellEditor(ItsNatComponent compEditor) Creates a default list editor instance using the specified component as the editor.
ItsNatListCellRenderer	createDefaultItsNatListCellRenderer() Creates a new default list element content renderer.
ItsNatListStructure	createDefaultItsNatListStructure() Creates a new default list structure manager.
ItsNatTableCellEditor	createDefaultItsNatTableCellEditor(ItsNatComponent compEditor) Creates a default table editor instance using the specified component as the editor.
ItsNatTableCellRenderer	createDefaultItsNatTableCellRenderer() Creates a new default table cell content renderer.
ItsNatTableHeaderCellRenderer	createDefaultItsNatTableHeaderCellRenderer() Creates a new default table header cell content renderer.
ItsNatTableStructure	createDefaultItsNatTableStructure() Creates a new default table structure manager.
ItsNatTreeCellEditor	createDefaultItsNatTreeCellEditor(ItsNatComponent compEditor) Creates a default tree node editor instance using the specified component as the editor.
ItsNatTreeCellRenderer	createDefaultItsNatTreeCellRenderer() Creates a new default tree node content renderer.
ItsNatTreeStructure	createDefaultItsNatTreeStructure() Creates a new default tree structure manager.
ItsNatButtonGroup	createItsNatButtonGroup() Creates a new ItsNat button group with a generated name and a new javax.swing.ButtonGroup.
ItsNatComponent	createItsNatComponent(Node node) Creates a new component object associated to the specified node.
ItsNatComponent	createItsNatComponent(Node node, String compType, NameValue[] artifacts) Creates a new component object associated to the specified node.
ItsNatComponent	createItsNatComponentById(String id) Creates a new component object associated to the node with the specified id attribute.
ItsNatComponent	createItsNatComponentById(String id, String compType, NameValue[] artifacts) Creates a new component object associated to the node with the specified id attribute.
ItsNatFreeButtonNormal	createItsNatFreeButtonNormal(Element element, NameValue[] artifacts) Creates a new free normal button component.
ItsNatFreeButtonNormalLabel	createItsNatFreeButtonNormalLabel(Element element, NameValue[] artifacts) Creates a new free normal button component with a label.
ItsNatFreeCheckBox	createItsNatFreeCheckBox(Element element, NameValue[] artifacts) Creates a new free check box component.
ItsNatFreeCheckBoxLabel	createItsNatFreeCheckBoxLabel(Element element, NameValue[] artifacts) Creates a new free check box component with a label.
ItsNatFreeComboBox	createItsNatFreeComboBox(Element element, ItsNatListStructure structure, NameValue[] artifacts) Creates a new free combo box component.
ItsNatFreeInclude	createItsNatFreeInclude(Element element, NameValue[] artifacts) Creates a new free include component.
ItsNatFreeLabel	createItsNatFreeLabel(Element element, NameValue[] artifacts) Creates a new free label component.
ItsNatFreeListMultSel	createItsNatFreeListMultSel(Element element, ItsNatListStructure structure, NameValue[] artifacts) Creates a new free list component.
ItsNatFreeRadioButton	createItsNatFreeRadioButton(Element element, NameValue[] artifacts) Creates a new free radio button component.
ItsNatFreeRadioButtonLabel	createItsNatFreeRadioButtonLabel(Element element, NameValue[] artifacts) Creates a new free radio buttom component with a label.
ItsNatFreeTable	createItsNatFreeTable(Element element, ItsNatTableStructure structure, NameValue[] artifacts) Creates a new free table component.
ItsNatFreeTree	createItsNatFreeTree(Element element, boolean treeTable, boolean rootless, ItsNatTreeStructure structure, NameValue[] artifacts) Creates a new free tree component.
ItsNatFreeTree	createItsNatFreeTree(Element element, NameValue[] artifacts) Creates a new free tree component.
ItsNatModalLayer	createItsNatModalLayer(Element element, boolean cleanBelow, float opacity, String background, NameValue[] artifacts) Creates a new modal layer component using the specified element if provided.
ItsNatModalLayer	createItsNatModalLayer(Element element, boolean cleanBelow, int zIndex, float opacity, String background, NameValue[] artifacts) Creates a new modal layer component using the specified element if provided.
ItsNatModalLayer	createItsNatModalLayer(Element element, NameValue[] artifacts) Creates a new modal layer component using the specified element if provided By default cleanBelow is false unless "cleanBelow" is defined as artifact or as a markup attribute.
ItsNatComponent	findItsNatComponent(Node node) Returns the registered component associated to the specified node.
ItsNatComponent	findItsNatComponentById(String id) Returns the registered component associated to the node which id attribute is specified.
ItsNatButtonGroup	getItsNatButtonGroup(ButtonGroup group) Returns the ItsNat button group with the specified Swing button group.
ItsNatButtonGroup	getItsNatButtonGroup(String name) Returns the ItsNat button group with the specified name.
ItsNatDocument	getItsNatDocument() Returns the associated ItsNat document (parent of this object).
boolean	isAutoBuildComponents() Informs whether components are built automatically using the necessary markup declarations.
boolean	isExcludedNodeAsItsNatComponent(Node node) Informs whether the specified node is in the excluded registry.
boolean	isMarkupDrivenComponents() Informs whether markup driven mode is used in new components.
boolean	isSelectionOnComponentsUsesKeyboard() Informs whether the keyboard is necessary for selection on components.
void	removeCreateItsNatComponentListener(CreateItsNatComponentListener listener) Removes the specified user defined component factory.
void	removeExcludedNodeAsItsNatComponent(Node node) Removes the specified node from the excluded registry.
ItsNatComponent	removeItsNatComponent(Node node) Unregisters the component associated to the specified node.
ItsNatComponent	removeItsNatComponent(String id) Unregisters the component associated to the node specified by the id attribute.
ItsNatComponent[]	removeItsNatComponents(boolean dispose) Navigates recursively the document and for every node removes the associated component if any from the registry and optionally disposes it.
ItsNatComponent[]	removeItsNatComponents(Node node, boolean dispose) Navigates recursively the subtree below the specified node (included) and for every node removes the associated component if any from the registry and optionally disposes it.
void	setAutoBuildComponents(boolean value) Sets whether components are built automatically using the necessary markup declarations.
void	setMarkupDrivenComponents(boolean value) Sets whether markup driven mode is used in components.
void	setSelectionOnComponentsUsesKeyboard(boolean value) Informs whether the keyboard is necessary for selection on components This method does not change the current state of already created components but may be the default value of new components with this feature.

Method Detail

getItsNatDocument

ItsNatDocument getItsNatDocument()

Returns the associated ItsNat document (parent of this object).

Returns:

the associated ItsNat document.

isAutoBuildComponents

boolean isAutoBuildComponents()

Informs whether components are built automatically using the necessary markup declarations.

If this feature is enabled any new DOM sub tree added to the document is automatically traversed, any component declared in markup is automatically built and registered into the component manager associated to a DOM element.

When a node is removed from the document tree the associated component if any is removed and disposed automatically.

The default value is defined by ItsNatDocumentTemplate.isAutoBuildComponents()

Returns:

true if automatic component build is enabled.

See Also:

setAutoBuildComponents(boolean)

setAutoBuildComponents

void setAutoBuildComponents(boolean value)

Sets whether components are built automatically using the necessary markup declarations.

Parameters:

value - true to enable automatic component build.

See Also:

isAutoBuildComponents()

isSelectionOnComponentsUsesKeyboard

boolean isSelectionOnComponentsUsesKeyboard()

Informs whether the keyboard is necessary for selection on components.

The default value is defined by ItsNatDocumentTemplate.isSelectionOnComponentsUsesKeyboard()

This feature only affects to non-XML documents with events enabled and free components with multiple selection support (lists, tables and trees).

Returns:

true if selection uses keyboard. True by default.

See Also:

setSelectionOnComponentsUsesKeyboard(boolean), ItsNatFreeListMultSel.isSelectionUsesKeyboard(), ItsNatTable.isSelectionUsesKeyboard(), ItsNatTree.isSelectionUsesKeyboard()

setSelectionOnComponentsUsesKeyboard

void setSelectionOnComponentsUsesKeyboard(boolean value)

Informs whether the keyboard is necessary for selection on components

This method does not change the current state of already created components but may be the default value of new components with this feature.

Parameters:

value - true to specify the keyboard is necessary for selection.

See Also:

isSelectionOnComponentsUsesKeyboard()

isMarkupDrivenComponents

boolean isMarkupDrivenComponents()

Informs whether markup driven mode is used in new components.

The default value is defined by ItsNatDocumentTemplate.isMarkupDrivenComponents()

This feature only affects to some HTML form based components.

Returns:

true if components are markup driven.

See Also:

setMarkupDrivenComponents(boolean), ItsNatHTMLInputButtonToggle.isMarkupDriven(), ItsNatHTMLInputTextBased.isMarkupDriven(), ItsNatHTMLTextArea.isMarkupDriven()

setMarkupDrivenComponents

void setMarkupDrivenComponents(boolean value)

Sets whether markup driven mode is used in components.

This method does not change the current state of already created components but may be the default value of new components with this feature.

Parameters:

value - true to enable markup driven.

See Also:

isMarkupDrivenComponents()

getItsNatButtonGroup

ItsNatButtonGroup getItsNatButtonGroup(String name)

Returns the ItsNat button group with the specified name.

Parameters:

name - the button group name to search for.

Returns:

the ItsNat button group, if not found a new one is registered and returned.

See Also:

getItsNatButtonGroup(javax.swing.ButtonGroup)

getItsNatButtonGroup

ItsNatButtonGroup getItsNatButtonGroup(ButtonGroup group)

Returns the ItsNat button group with the specified Swing button group.

Parameters:

group - the Swing button group to search for.

Returns:

the ItsNat button group, if not found a new one is registered and returned.

See Also:

getItsNatButtonGroup(String)

createItsNatButtonGroup

ItsNatButtonGroup createItsNatButtonGroup()

Creates a new ItsNat button group with a generated name and a new javax.swing.ButtonGroup.

Generated name is unique per document.

Returns:

a new ItsNat button group.

addCreateItsNatComponentListener

void addCreateItsNatComponentListener(CreateItsNatComponentListener listener)

Adds a new user defined component factory. This listener is called when the framework needs to create a component instance.

Parameters:

listener - the listener factory to register.

See Also:

removeCreateItsNatComponentListener(CreateItsNatComponentListener), ItsNatDocumentTemplate.addCreateItsNatComponentListener(CreateItsNatComponentListener), ItsNatServlet.addCreateItsNatComponentListener(CreateItsNatComponentListener)

removeCreateItsNatComponentListener

void removeCreateItsNatComponentListener(CreateItsNatComponentListener listener)

Removes the specified user defined component factory.

Parameters:

listener - the listener factory to remove.

See Also:

addCreateItsNatComponentListener(CreateItsNatComponentListener)

createItsNatComponent

ItsNatComponent createItsNatComponent(Node node,
                                    String compType,
                                    NameValue[] artifacts)

Creates a new component object associated to the specified node.

All registered CreateItsNatComponentListener listeners are used to create the component.

Parameters:

node - the node to associate the new component.

compType - the component type, if null the type is obtained from the node.

artifacts - declared artifacts, may be null.

Returns:

the new component, is null if no component can be created with the submitted parameters.

See Also:

addCreateItsNatComponentListener(CreateItsNatComponentListener), ItsNatDocumentTemplate.addCreateItsNatComponentListener(CreateItsNatComponentListener), ItsNatServlet.addCreateItsNatComponentListener(CreateItsNatComponentListener)

createItsNatComponent

ItsNatComponent createItsNatComponent(Node node)

Creates a new component object associated to the specified node.

Current implementation calls:

  return createItsNatComponent(node,null,null);
 

Parameters:

node - the node to associate the new component.

Returns:

the new component, is null if no component can be created.

See Also:

createItsNatComponent(org.w3c.dom.Node,String,NameValue[])

createItsNatComponentById

ItsNatComponent createItsNatComponentById(String id)

Creates a new component object associated to the node with the specified id attribute.

Current implementation calls:

  return createItsNatComponentById(id,null,null);
 

Parameters:

id - the attribute id of the node to associate the new component.

Returns:

the new component, is null if no component can be created.

See Also:

createItsNatComponentById(String,String,NameValue[])

createItsNatComponentById

ItsNatComponent createItsNatComponentById(String id,
                                        String compType,
                                        NameValue[] artifacts)

Creates a new component object associated to the node with the specified id attribute.

Current implementation:

   Document doc = getItsNatDocument().getDocument();
   Element node = doc.getElementById(id);
   return createItsNatComponent(node,compType,artifacts);
 

Parameters:

id - the attribute id of the node to associate the new component.

compType - the component type, if null the type is obtained from the node.

artifacts - declared artifacts, may be null.

Returns:

the new component, is null if no component can be created.

See Also:

createItsNatComponent(org.w3c.dom.Node,String,NameValue[])

addItsNatComponent

ItsNatComponent addItsNatComponent(Node node,
                                 String compType,
                                 NameValue[] artifacts)

Creates and adds to the manager registry a new component object associated to the specified node.

Component creation is delegated to the method createItsNatComponent(org.w3c.dom.Node,String,NameValue[]), if no component can be created nothing is registered.

If the node specified was registered as excluded calling addExcludedNodeAsItsNatComponent(org.w3c.dom.Node) no component is created and registered.

Parameters:

node - the node to associate the new component.

compType - the component type, if null the type is obtained from the node.

artifacts - declared artifacts, may be null.

Returns:

the new component, is null if no component can be created with the submitted parameters.

See Also:

addItsNatComponent(ItsNatComponent)

addItsNatComponent

ItsNatComponent addItsNatComponent(Node node)

Creates and adds to the manager registry a new component object associated to the specified node.

Current implementation calls:

 return addItsNatComponent(node,null,null);
 

Parameters:

node - the node to associate the new component.

Returns:

the new component, is null if no component can be created with the submitted parameters.

See Also:

addItsNatComponent(org.w3c.dom.Node,String,NameValue[])

addItsNatComponentById

ItsNatComponent addItsNatComponentById(String id)

Creates and adds to the manager registry a new component object associated to the node with the specified id attribute.

Current implementation calls:

 return addItsNatComponentById(id,null,null);
 

Parameters:

id - the attribute id of the node to associate the new component.

Returns:

the new component, is null if no component can be created with the submitted parameters.

See Also:

addItsNatComponentById(String,String,NameValue[])

addItsNatComponentById

ItsNatComponent addItsNatComponentById(String id,
                                     String compType,
                                     NameValue[] artifacts)

Creates and adds to the manager registry a new component object associated to the node with the specified id attribute.

Current implementation:

   Document doc = getItsNatDocument().getDocument();
   Element node = doc.getElementById(id);
   return addItsNatComponent(node,compType,artifacts);
 

Parameters:

id - the attribute id of the node to associate the new component.

compType - the component type, if null the type is obtained from the node.

artifacts - declared artifacts, may be null.

Returns:

the new component, is null if no component can be created with the submitted parameters.

See Also:

addItsNatComponent(org.w3c.dom.Node,String,NameValue[])

addItsNatComponent

ItsNatComponent addItsNatComponent(ItsNatComponent comp)

Adds to the manager registry the specified component object.

This method ignores the "excluded registry".

Parameters:

comp - the component to register.

Returns:

the previously registered component associated to the node of the new component or null

See Also:

addItsNatComponent(org.w3c.dom.Node,String,NameValue[]), addExcludedNodeAsItsNatComponent(org.w3c.dom.Node)

findItsNatComponentById

ItsNatComponent findItsNatComponentById(String id)

Returns the registered component associated to the node which id attribute is specified.

Current implementation:

   Document doc = getItsNatDocument().getDocument();
   Element node = doc.getElementById(id);
   return findItsNatComponent(node);
 

Parameters:

id - the attribute id of the node to search.

Returns:

the component associated to the specified node or null if not found.

See Also:

findItsNatComponent(org.w3c.dom.Node)

findItsNatComponent

ItsNatComponent findItsNatComponent(Node node)

Returns the registered component associated to the specified node.

Parameters:

node - the node the search the associated component.

Returns:

the component associated to the specified node or null if not found.

See Also:

addItsNatComponent(org.w3c.dom.Node)

removeItsNatComponent

ItsNatComponent removeItsNatComponent(Node node)

Unregisters the component associated to the specified node.

Parameters:

node - the node the search the associated component.

Returns:

the component associated to the specified node or null if not found.

See Also:

findItsNatComponent(org.w3c.dom.Node)

removeItsNatComponent

ItsNatComponent removeItsNatComponent(String id)

Unregisters the component associated to the node specified by the id attribute.

Current implementation:

   Document doc = getItsNatDocument().getDocument();
   Element node = doc.getElementById(id);
   return removeItsNatComponent(node);
 

Parameters:

id - the attribute id of the node to search.

Returns:

the component associated to the specified node or null if not found.

See Also:

removeItsNatComponent(org.w3c.dom.Node)

addExcludedNodeAsItsNatComponent

void addExcludedNodeAsItsNatComponent(Node node)

Registers the specified node in the excluded registry.

No component is created and registered with addItsNatComponent(org.w3c.dom.Node,String,NameValue[]) if the specified node is in the excluded registry.

Parameters:

node - the node to exclude.

removeExcludedNodeAsItsNatComponent

void removeExcludedNodeAsItsNatComponent(Node node)

Removes the specified node from the excluded registry.

Parameters:

node - the node to exclude.

See Also:

addExcludedNodeAsItsNatComponent(org.w3c.dom.Node)

isExcludedNodeAsItsNatComponent

boolean isExcludedNodeAsItsNatComponent(Node node)

Informs whether the specified node is in the excluded registry.

Parameters:

node - the node to search for.

See Also:

addExcludedNodeAsItsNatComponent(org.w3c.dom.Node)

buildItsNatComponents

ItsNatComponent[] buildItsNatComponents(Node node)

Navigates recursively the subtree below the specified node (included) and for every node tries to create and register the built-in component associated to the node.

Parameters:

node - the node parent of the subtree.

Returns:

an array with the components created and registered.

See Also:

buildItsNatComponents(), removeItsNatComponents(org.w3c.dom.Node,boolean), addItsNatComponent(org.w3c.dom.Node)

buildItsNatComponents

ItsNatComponent[] buildItsNatComponents()

Navigates recursively the document tree and for every node tries to create and register the built-in component associated to the node.

Current implementation is:

  Document doc = getItsNatDocument().getDocument();
  return buildItsNatComponents(doc);
 

Returns:

an array with the components created and registered.

See Also:

buildItsNatComponents(org.w3c.dom.Node)

removeItsNatComponents

ItsNatComponent[] removeItsNatComponents(Node node,
                                       boolean dispose)

Navigates recursively the subtree below the specified node (included) and for every node removes the associated component if any from the registry and optionally disposes it.

Parameters:

node - the node parent of the subtree.

dispose - if every component found is disposed.

Returns:

an array with the components removed.

See Also:

removeItsNatComponents(boolean), removeItsNatComponent(org.w3c.dom.Node), buildItsNatComponents(org.w3c.dom.Node)

removeItsNatComponents

ItsNatComponent[] removeItsNatComponents(boolean dispose)

Navigates recursively the document and for every node removes the associated component if any from the registry and optionally disposes it.

Parameters:

dispose - if every component found is disposed.

Returns:

an array with the components removed.

See Also:

removeItsNatComponents(org.w3c.dom.Node,boolean)

createDefaultItsNatLabelEditor

ItsNatLabelEditor createDefaultItsNatLabelEditor(ItsNatComponent compEditor)

Creates a default label editor instance using the specified component as the editor.

Current implementation supports ItsNatHTMLInputText, ItsNatHTMLSelectComboBox, ItsNatHTMLInputCheckBox and ItsNatHTMLTextArea as editors.

Parameters:

compEditor - the component used as editor. If null ItsNatHTMLInputText (text not formatted version) is used.

Returns:

a default label editor instance.

createDefaultItsNatListCellEditor

ItsNatListCellEditor createDefaultItsNatListCellEditor(ItsNatComponent compEditor)

Creates a default list editor instance using the specified component as the editor.

Current implementation supports ItsNatHTMLInputText, ItsNatHTMLSelectComboBox, ItsNatHTMLInputCheckBox and ItsNatHTMLTextArea as editors.

Parameters:

compEditor - the component used as editor. If null ItsNatHTMLInputText (text not formatted version) is used.

Returns:

a default list item editor instance.

createDefaultItsNatTableCellEditor

ItsNatTableCellEditor createDefaultItsNatTableCellEditor(ItsNatComponent compEditor)

Creates a default table editor instance using the specified component as the editor.

Current implementation supports ItsNatHTMLInputText, ItsNatHTMLSelectComboBox, ItsNatHTMLInputCheckBox and ItsNatHTMLTextArea as editors.

Parameters:

compEditor - the component used as editor. If null ItsNatHTMLInputText (text not formatted version) is used.

Returns:

a default table cell editor instance.

createDefaultItsNatTreeCellEditor

ItsNatTreeCellEditor createDefaultItsNatTreeCellEditor(ItsNatComponent compEditor)

Creates a default tree node editor instance using the specified component as the editor.

Current implementation supports ItsNatHTMLInputText, ItsNatHTMLSelectComboBox, ItsNatHTMLInputCheckBox and ItsNatHTMLTextArea as editors.

Parameters:

compEditor - the component used as editor. If null ItsNatHTMLInputText (text not formatted version) is used.

Returns:

a default tree node editor instance.

createDefaultItsNatLabelRenderer

ItsNatLabelRenderer createDefaultItsNatLabelRenderer()

Creates a new default label renderer.

Returns:

a new default label renderer.

createDefaultItsNatListCellRenderer

ItsNatListCellRenderer createDefaultItsNatListCellRenderer()

Creates a new default list element content renderer.

Returns:

a new default list element content renderer.

createDefaultItsNatTableCellRenderer

ItsNatTableCellRenderer createDefaultItsNatTableCellRenderer()

Creates a new default table cell content renderer.

Returns:

a new default table cell content renderer.

createDefaultItsNatTableHeaderCellRenderer

ItsNatTableHeaderCellRenderer createDefaultItsNatTableHeaderCellRenderer()

Creates a new default table header cell content renderer.

Returns:

a new default table header cell content renderer.

createDefaultItsNatTreeCellRenderer

ItsNatTreeCellRenderer createDefaultItsNatTreeCellRenderer()

Creates a new default tree node content renderer.

Returns:

a new default tree node content renderer.

createDefaultItsNatListStructure

ItsNatListStructure createDefaultItsNatListStructure()

Creates a new default list structure manager.

Returns:

a new default list structure manager.

createDefaultItsNatTableStructure

ItsNatTableStructure createDefaultItsNatTableStructure()

Creates a new default table structure manager.

Returns:

a new default table structure manager.

createDefaultItsNatTreeStructure

ItsNatTreeStructure createDefaultItsNatTreeStructure()

Creates a new default tree structure manager.

Returns:

a new default tree structure manager.

createItsNatFreeInclude

ItsNatFreeInclude createItsNatFreeInclude(Element element,
                                        NameValue[] artifacts)

Creates a new free include component.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free include component.

createItsNatFreeLabel

ItsNatFreeLabel createItsNatFreeLabel(Element element,
                                    NameValue[] artifacts)

Creates a new free label component.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free label component.

createItsNatFreeButtonNormal

ItsNatFreeButtonNormal createItsNatFreeButtonNormal(Element element,
                                                  NameValue[] artifacts)

Creates a new free normal button component.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free normal button component.

createItsNatFreeButtonNormalLabel

ItsNatFreeButtonNormalLabel createItsNatFreeButtonNormalLabel(Element element,
                                                            NameValue[] artifacts)

Creates a new free normal button component with a label.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free normal button component.

createItsNatFreeCheckBox

ItsNatFreeCheckBox createItsNatFreeCheckBox(Element element,
                                          NameValue[] artifacts)

Creates a new free check box component.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free check box component.

createItsNatFreeCheckBoxLabel

ItsNatFreeCheckBoxLabel createItsNatFreeCheckBoxLabel(Element element,
                                                    NameValue[] artifacts)

Creates a new free check box component with a label.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free check box component.

createItsNatFreeRadioButton

ItsNatFreeRadioButton createItsNatFreeRadioButton(Element element,
                                                NameValue[] artifacts)

Creates a new free radio button component.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free radio buttom component.

createItsNatFreeRadioButtonLabel

ItsNatFreeRadioButtonLabel createItsNatFreeRadioButtonLabel(Element element,
                                                          NameValue[] artifacts)

Creates a new free radio buttom component with a label.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free radio buttom component.

createItsNatFreeComboBox

ItsNatFreeComboBox createItsNatFreeComboBox(Element element,
                                          ItsNatListStructure structure,
                                          NameValue[] artifacts)

Creates a new free combo box component.

Parameters:

element - the DOM element associated. Can not be null.

structure - the specified structure, if null then is obtained from artifacts ("useStructure"), if not defined then from markup ("useStructure" attribute), if not defined the default structure is used.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free combo box component.

See Also:

createDefaultItsNatListStructure()

createItsNatFreeListMultSel

ItsNatFreeListMultSel createItsNatFreeListMultSel(Element element,
                                                ItsNatListStructure structure,
                                                NameValue[] artifacts)

Creates a new free list component.

Parameters:

element - the DOM element associated. Can not be null.

structure - the specified structure, if null then is obtained from artifacts ("useStructure"), if not defined then from markup ("useStructure" attribute), if not defined the default structure is used.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free list component.

See Also:

createDefaultItsNatListStructure()

createItsNatFreeTable

ItsNatFreeTable createItsNatFreeTable(Element element,
                                    ItsNatTableStructure structure,
                                    NameValue[] artifacts)

Creates a new free table component.

Parameters:

element - the DOM element associated. Can not be null.

structure - the specified structure, if null then is obtained from artifacts ("useStructure"), if not defined then from markup ("useStructure" attribute), if not defined the default structure is used.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free table component.

See Also:

createDefaultItsNatTableStructure()

createItsNatFreeTree

ItsNatFreeTree createItsNatFreeTree(Element element,
                                  boolean treeTable,
                                  boolean rootless,
                                  ItsNatTreeStructure structure,
                                  NameValue[] artifacts)

Creates a new free tree component.

Parameters:

element - the DOM element associated. Can not be null.

treeTable - true if this tree is a tree-table.

rootless - true if this tree is rootless (root node has not view).

structure - the specified structure, if null then is obtained from artifacts ("useStructure"), if not defined then from markup ("useStructure" attribute), if not defined the default structure is used.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free tree component.

See Also:

createDefaultItsNatTreeStructure(), createItsNatFreeTree(Element,NameValue[])

createItsNatFreeTree

ItsNatFreeTree createItsNatFreeTree(Element element,
                                  NameValue[] artifacts)

Creates a new free tree component.

By default is not a tree-table unless "treeTable" is defined in the artifacts (value "true") or as a markup attribute (value "true").

By default the root node has view unless "rootless" is defined in the artifacts (value "true") or as a markup attribute (value "true").

The structure is obtained from artifacts ("useStructure"), if not defined then from markup ("useStructure" attribute), if not defined the default structure is used.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new free tree component.

See Also:

createItsNatFreeTree(Element,boolean,boolean,ItsNatTreeStructure,NameValue[])

createItsNatModalLayer

ItsNatModalLayer createItsNatModalLayer(Element element,
                                      boolean cleanBelow,
                                      int zIndex,
                                      float opacity,
                                      String background,
                                      NameValue[] artifacts)

Creates a new modal layer component using the specified element if provided.

The z-index associated to the modal layer is the number of modal layer components created before (and not disposed) + 1.

If the background parameter is null, no background property is set. This value is not recommended if you want transparency because in some browsers like MSIE 6 if background is not set the layer allows clicking below. Use opacity=0 and any background color to get a transparent layer capturing click events.

In SVG the background parameter is used to the fill property

Parameters:

element - the DOM element used to cover the page. May be null (an internal element is used).

cleanBelow - use the clean layer technique.

opacity - a value between 0 and 1 defining the opacity of the modal layer (1 = opaque, 0 = transparent).

background - the background CSS property of the modal layer (fill property in SVG). If null no background is set.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new modal layer component.

createItsNatModalLayer

ItsNatModalLayer createItsNatModalLayer(Element element,
                                      boolean cleanBelow,
                                      float opacity,
                                      String background,
                                      NameValue[] artifacts)

Creates a new modal layer component using the specified element if provided.

By default z-index is the number of current modal layers + 1 unless "zIndex" is defined as artifact or as a markup attribute.

Parameters:

element - the DOM element used to cover the page. May be null (an internal element is used).

cleanBelow - use the clean layer technique.

opacity - a value between 0 and 1 defining the opacity of the modal layer (1 = opaque, 0 = transparent).

background - the background CSS property of the modal layer (fill property in SVG). If null no background is set.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new modal layer component.

See Also:

createItsNatModalLayer(Element,boolean,int,float,String,NameValue[])

createItsNatModalLayer

ItsNatModalLayer createItsNatModalLayer(Element element,
                                      NameValue[] artifacts)

Creates a new modal layer component using the specified element if provided

By default cleanBelow is false unless "cleanBelow" is defined as artifact or as a markup attribute.

By default z-index is the number of current modal layers + 1 unless "zIndex" is defined as artifact or as a markup attribute.

By default opacity is 1.0 unless "opacity" is defined as artifact or as a markup attribute.

By default background is "black" unless "background" is defined as artifact or as a markup attribute. In XUL is set to null.

Parameters:

element - the DOM element associated. Can not be null.

artifacts - artifacts used to construct the component. May be null.

Returns:

a new modal layer component.

See Also:

createItsNatModalLayer(Element,boolean,int,float,String,NameValue[])