IElement

```
public interface IElement
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_NON_CELLS`
`static int`	`ALL_NON_DOCUMENT_CELLS`
`static int`	`ALL_TYPES`
`static int`	`CELL`
`static String`	`CELL_SEPERATOR`
`static String`	`CLASS_SEPERATOR`
`static int`	`DOCUMENT`
`static java.util.List<IElement>`	`EMPTY`
`static int`	`FOLDER`
`static de.toem.pattern.element.Element`	`NONE`
`static String`	`PATH_SEPERATOR`
`static int`	`PROJECT`
`static String`	`UNKNOWN_NAME`
`static int`	`WORKSPACE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`aboutToModify(de.toem.pattern.element.ElementModifierEvent event)`
`IElement`	`addChild(IElement child, String name, int action)`
`IElement`	`addInitializer(de.toem.pattern.element.initializer.IElementInitializer initializer)`
`void`	`addListener(IElementListener listener)`
`void`	`bind(IElement container)`
`boolean`	`canBeAdded(IElement element)`
`boolean`	`canBeAddedAs(IElement element, String name)`
`boolean`	`canBeModified()`
`boolean`	`canBeOverwrittenAs(IElement element, String name)`
`boolean`	`canBeRemoved(IElement element)`
`boolean`	`canBeRenamed(IElement element)`
`boolean`	`canBeRenamed(IElement element, String name)`
`boolean`	`canBeSaved()`
`void`	`clearHint(String key)`
`void`	`clearResourceData(de.toem.pattern.threading.IProgress progress)`
`void`	`clearUndoHistory()`
`void`	`fireElementAboutToBeModified(de.toem.pattern.element.ElementModifierEvent event)`
`void`	`fireElementBound()`
`void`	`fireElementLoaded(boolean coverOnly)`
`void`	`fireElementModified(de.toem.pattern.element.ElementModifierEvent event, boolean includeFactoryListener)`
`void`	`fireElementResetted()`
`void`	`fireElementUnbound(boolean fromModifier)`
`ICell`	`getCell()`
`ICell`	`getCell(de.toem.pattern.threading.IProgress progress)`
`ICell`	`getCellByHunt(String hunt)`
`ICell`	`getCellByLink(de.toem.pattern.element.Link link)`
`ICell`	`getCellByLink(de.toem.pattern.element.Link link, Class<? extends ICell> clazz)`
`ICell`	`getCellByPath(String cellPath)`
`ICell`	`getCellByPath(String cellPath, Class<? extends ICell> clazz)`
`InputStream`	`getCellData(de.toem.pattern.threading.IProgress progress)`
`String`	`getCellType()`
`IElement`	`getChild(String name)`
`java.util.List<IElement>`	`getChildren()`
`java.util.List<IElement>`	`getChildren(de.toem.pattern.threading.IProgress progress)`
`java.util.List<IElement>`	`getChildren(de.toem.pattern.threading.IProgress progress, Class<? extends ICell> cellClass)`
`java.util.List<IElement>`	`getChildren(de.toem.pattern.threading.IProgress progress, Class<? extends ICell>[] cellClasses)`
`java.util.List<IElement>`	`getChildren(de.toem.pattern.threading.IProgress progress, int types)`
`java.util.List<IElement>`	`getChildren(de.toem.pattern.threading.IProgress progress, String cellType)`
`java.util.List<IElement>`	`getChildren(de.toem.pattern.threading.IProgress progress, String[] cellTypes)`
`IElement`	`getContainer()`
`java.util.List<IElement>`	`getContainers()`
`ICover`	`getCover()`
`InputStream`	`getData(de.toem.pattern.threading.IProgress progress)`
`String`	`getDescription()`
`IElement`	`getDocumentContainer()`
`IElement`	`getElement(de.toem.pattern.element.Link link)`
`IElement`	`getElement(String path)`
`IElement`	`getFolderContainer()`
`String`	`getHint(String key)`
`java.util.Map<String,String>`	`getHints()`
`de.toem.pattern.element.Link`	`getLink()`
`de.toem.pattern.element.Link`	`getLink(IElement base)`
`de.toem.pattern.element.exploits.Marker[]`	`getMarkers()`
`String`	`getName()`
`String`	`getPath()`
`String`	`getPath(IElement base)`
`IElement`	`getProjectContainer()`
`Object`	`getProperty(String key)`
`IElementProvider`	`getProvider()`
`Object`	`getResource()`
`String`	`getResourceClass()`
`IElement`	`getResourceContainer()`
`InputStream`	`getResourceData(de.toem.pattern.threading.IProgress progress)`
`IElement`	`getRootContainer()`
`de.toem.pattern.element.constant.TransferElement`	`getTransfer(boolean includeChildChapters)`
`java.util.List<IElement>`	`getTribe(de.toem.pattern.threading.IProgress progress, boolean includeThis, boolean includeChapters)`
`int`	`getType()`
`Object`	`getUndoContext()`
`IElement`	`getWorkspaceContainer()`
`boolean`	`hasCell()`
`boolean`	`hasCell(Class<? extends ICell> c)`
`boolean`	`hasCell(Class<? extends ICell>[] cs)`
`boolean`	`hasCell(String cellType)`
`boolean`	`hasCell(String[] cellTypes)`
`boolean`	`hasChild(String name)`
`boolean`	`hasChildren()`
`boolean`	`hasContainer()`
`boolean`	`hasEditor()`
`boolean`	`hasHint(String key)`
`boolean`	`hasOrderedChildren()`
`boolean`	`hasResource()`
`boolean`	`hasResourceContainer()`
`boolean`	`hasViewer()`
`int`	`indexOf(IElement element)`
`IElement`	`insertChild(IElement child, String name, int index, int action)`
`boolean`	`isAccessible()`
`boolean`	`isBound()`
`boolean`	`isCell()`
`boolean`	`isCellLoaded()`
`boolean`	`isConstant()`
`boolean`	`isContainer()`
`boolean`	`isContainer(IElement element)`
`boolean`	`isDirty()`
`boolean`	`isDocument()`
`boolean`	`isFolder()`
`boolean`	`isNone()`
`boolean`	`isProject()`
`boolean`	`isResourceOutOfSync()`
`boolean`	`isResourceReadOnly()`
`boolean`	`isResourceValid()`
`boolean`	`isTribe(IElement element)`
`boolean`	`isWorkspace()`
`void`	`modified(de.toem.pattern.element.ElementModifierEvent event)`
`int`	`removeChild(IElement child, int action, boolean keepData)`
`void`	`removeListener(IElementListener listener)`
`void`	`rename(IElement child, String newName)`
`int`	`reorderChild(IElement child, int index, int action)`
`void`	`reset()`
`void`	`save(de.toem.pattern.threading.IProgress progress)`
`void`	`setHint(String key, String value)`
`void`	`setHints(java.util.Map<String,String> hints)`
`void`	`syncResource()`
`void`	`unBind(boolean modification)`
`String`	`uniqueChildName(String name)`

Field Detail
- NONE
```
static final de.toem.pattern.element.Element NONE
```
- EMPTY
```
static final java.util.List<IElement> EMPTY
```
- CLASS_SEPERATOR
```
static final String CLASS_SEPERATOR
```
  See Also:
  
  Constant Field Values
- PATH_SEPERATOR
```
static final String PATH_SEPERATOR
```
  See Also:
  
  Constant Field Values
- CELL_SEPERATOR
```
static final String CELL_SEPERATOR
```
  See Also:
  
  Constant Field Values
- UNKNOWN_NAME
```
static final String UNKNOWN_NAME
```
  See Also:
  
  Constant Field Values
- WORKSPACE
```
static final int WORKSPACE
```
  See Also:
  
  Constant Field Values
- PROJECT
```
static final int PROJECT
```
  See Also:
  
  Constant Field Values
- FOLDER
```
static final int FOLDER
```
  See Also:
  
  Constant Field Values
- DOCUMENT
```
static final int DOCUMENT
```
  See Also:
  
  Constant Field Values
- CELL
```
static final int CELL
```
  See Also:
  
  Constant Field Values
- ALL_TYPES
```
static final int ALL_TYPES
```
  See Also:
  
  Constant Field Values
- ALL_NON_CELLS
```
static final int ALL_NON_CELLS
```
  See Also:
  
  Constant Field Values
- ALL_NON_DOCUMENT_CELLS
```
static final int ALL_NON_DOCUMENT_CELLS
```
  See Also:
  
  Constant Field Values

Method Detail

isNone
```
boolean isNone()
```

isBound
```
boolean isBound()
```

bind
```
void bind(IElement container)
```

unBind
```
void unBind(boolean modification)
```

addInitializer

IElement addInitializer(de.toem.pattern.element.initializer.IElementInitializer initializer)

getName
```
String getName()
```

getDescription
```
String getDescription()
```

getPath
```
String getPath()
```

getPath
```
String getPath(IElement base)
```

isConstant
```
boolean isConstant()
```

isAccessible
```
boolean isAccessible()
```

getType
```
int getType()
```

isContainer
```
boolean isContainer()
```

isWorkspace
```
boolean isWorkspace()
```

isProject
```
boolean isProject()
```

isFolder
```
boolean isFolder()
```

isDocument
```
boolean isDocument()
```

isCell
```
boolean isCell()
```

getLink
```
de.toem.pattern.element.Link getLink()
```

getLink

de.toem.pattern.element.Link getLink(IElement base)

getUndoContext
```
Object getUndoContext()
```

clearUndoHistory
```
void clearUndoHistory()
```

getProperty
```
Object getProperty(String key)
```

getMarkers

de.toem.pattern.element.exploits.Marker[] getMarkers()

hasContainer
```
boolean hasContainer()
```

getContainer
```
IElement getContainer()
```

getRootContainer
```
IElement getRootContainer()
```

getContainers

java.util.List<IElement> getContainers()

getDocumentContainer
```
IElement getDocumentContainer()
```

getFolderContainer
```
IElement getFolderContainer()
```

getProjectContainer
```
IElement getProjectContainer()
```

getWorkspaceContainer
```
IElement getWorkspaceContainer()
```

hasChildren
```
boolean hasChildren()
```

hasChild
```
boolean hasChild(String name)
```

getChild
```
IElement getChild(String name)
```

getElement
```
IElement getElement(String path)
```

getElement

IElement getElement(de.toem.pattern.element.Link link)

hasOrderedChildren
```
boolean hasOrderedChildren()
```

indexOf
```
int indexOf(IElement element)
```

getChildren
```
java.util.List<IElement> getChildren()
```

getChildren

java.util.List<IElement> getChildren(de.toem.pattern.threading.IProgress progress)

getChildren

java.util.List<IElement> getChildren(de.toem.pattern.threading.IProgress progress,
                                     int types)

getChildren

java.util.List<IElement> getChildren(de.toem.pattern.threading.IProgress progress,
                                     String[] cellTypes)

getChildren

java.util.List<IElement> getChildren(de.toem.pattern.threading.IProgress progress,
                                     String cellType)

getChildren

java.util.List<IElement> getChildren(de.toem.pattern.threading.IProgress progress,
                                     Class<? extends ICell> cellClass)

getChildren

java.util.List<IElement> getChildren(de.toem.pattern.threading.IProgress progress,
                                     Class<? extends ICell>[] cellClasses)

getTribe

java.util.List<IElement> getTribe(de.toem.pattern.threading.IProgress progress,
                                  boolean includeThis,
                                  boolean includeChapters)

isTribe
```
boolean isTribe(IElement element)
```

isContainer
```
boolean isContainer(IElement element)
```

canBeModified
```
boolean canBeModified()
```

canBeSaved
```
boolean canBeSaved()
```

canBeAdded
```
boolean canBeAdded(IElement element)
```

canBeAddedAs

boolean canBeAddedAs(IElement element,
                     String name)

canBeOverwrittenAs

boolean canBeOverwrittenAs(IElement element,
                           String name)

canBeRemoved

boolean canBeRemoved(IElement element)

canBeRenamed

boolean canBeRenamed(IElement element,
                     String name)

canBeRenamed

boolean canBeRenamed(IElement element)

uniqueChildName
```
String uniqueChildName(String name)
```

addChild

IElement addChild(IElement child,
                  String name,
                  int action)

insertChild

IElement insertChild(IElement child,
                     String name,
                     int index,
                     int action)

removeChild

int removeChild(IElement child,
                int action,
                boolean keepData)

reorderChild

int reorderChild(IElement child,
                 int index,
                 int action)

rename

void rename(IElement child,
            String newName)

hasResource
```
boolean hasResource()
```

hasResourceContainer
```
boolean hasResourceContainer()
```

getResourceContainer
```
IElement getResourceContainer()
```

getResourceClass
```
String getResourceClass()
```

getResource
```
Object getResource()
```

getProvider
```
IElementProvider getProvider()
```

isResourceReadOnly
```
boolean isResourceReadOnly()
```

isResourceValid
```
boolean isResourceValid()
```

isResourceOutOfSync
```
boolean isResourceOutOfSync()
```

syncResource
```
void syncResource()
```

isDirty
```
boolean isDirty()
```

reset
```
void reset()
```

save

void save(de.toem.pattern.threading.IProgress progress)

clearResourceData

void clearResourceData(de.toem.pattern.threading.IProgress progress)

getResourceData

InputStream getResourceData(de.toem.pattern.threading.IProgress progress)

getCellData

InputStream getCellData(de.toem.pattern.threading.IProgress progress)

getData

InputStream getData(de.toem.pattern.threading.IProgress progress)

hasCell
```
boolean hasCell()
```

getCellType
```
String getCellType()
```

hasCell
```
boolean hasCell(String[] cellTypes)
```

hasCell
```
boolean hasCell(String cellType)
```

hasCell

boolean hasCell(Class<? extends ICell> c)

hasCell

boolean hasCell(Class<? extends ICell>[] cs)

isCellLoaded
```
boolean isCellLoaded()
```

getCell
```
ICell getCell()
```

getCell

ICell getCell(de.toem.pattern.threading.IProgress progress)

getCellByPath
```
ICell getCellByPath(String cellPath)
```

getCellByPath

ICell getCellByPath(String cellPath,
                    Class<? extends ICell> clazz)

getCellByLink

ICell getCellByLink(de.toem.pattern.element.Link link)

getCellByLink

ICell getCellByLink(de.toem.pattern.element.Link link,
                    Class<? extends ICell> clazz)

getCellByHunt
```
ICell getCellByHunt(String hunt)
```

getCover
```
ICover getCover()
```

modified

void modified(de.toem.pattern.element.ElementModifierEvent event)

aboutToModify

boolean aboutToModify(de.toem.pattern.element.ElementModifierEvent event)

addListener

void addListener(IElementListener listener)

removeListener

void removeListener(IElementListener listener)

fireElementModified

void fireElementModified(de.toem.pattern.element.ElementModifierEvent event,
                         boolean includeFactoryListener)

fireElementAboutToBeModified

void fireElementAboutToBeModified(de.toem.pattern.element.ElementModifierEvent event)

fireElementResetted
```
void fireElementResetted()
```

fireElementLoaded

void fireElementLoaded(boolean coverOnly)

fireElementBound
```
void fireElementBound()
```

fireElementUnbound

void fireElementUnbound(boolean fromModifier)

hasEditor
```
boolean hasEditor()
```

hasViewer
```
boolean hasViewer()
```

hasHint
```
boolean hasHint(String key)
```

getHint
```
String getHint(String key)
```

getHints

java.util.Map<String,String> getHints()

setHint

void setHint(String key,
             String value)

setHints

void setHints(java.util.Map<String,String> hints)

clearHint
```
void clearHint(String key)
```

getTransfer

de.toem.pattern.element.constant.TransferElement getTransfer(boolean includeChildChapters)

Interface IElement

Field Summary

Method Summary

Field Detail

NONE

EMPTY

CLASS_SEPERATOR

PATH_SEPERATOR

CELL_SEPERATOR

UNKNOWN_NAME

WORKSPACE

PROJECT

FOLDER

DOCUMENT

CELL

ALL_TYPES

ALL_NON_CELLS

ALL_NON_DOCUMENT_CELLS

Method Detail

isNone

isBound

bind

unBind

addInitializer

getName

getDescription

getPath

getPath

isConstant

isAccessible

getType

isContainer

isWorkspace

isProject

isFolder

isDocument

isCell

getLink

getLink

getUndoContext

clearUndoHistory

getProperty

getMarkers

hasContainer

getContainer

getRootContainer

getContainers

getDocumentContainer

getFolderContainer

getProjectContainer

getWorkspaceContainer

hasChildren

hasChild

getChild

getElement

getElement

hasOrderedChildren

indexOf

getChildren

getChildren

getChildren

getChildren

getChildren

getChildren

getChildren

getTribe

isTribe

isContainer

canBeModified

canBeSaved

canBeAdded

canBeAddedAs

canBeOverwrittenAs

canBeRemoved

canBeRenamed

canBeRenamed

uniqueChildName

addChild

insertChild

removeChild