Gridarta Editor
net.sf.gridarta.model.data.NamedObject Interface Reference

An. More...

+ Inheritance diagram for net.sf.gridarta.model.data.NamedObject:
+ Collaboration diagram for net.sf.gridarta.model.data.NamedObject:

Public Member Functions

String getDisplayIconName ()
 Returns the face name of the display icon for this AbstractNamedObject. More...
 
String getName ()
 Get the name of this AbstractNamedObject. More...
 
String getPath ()
 Get the path of this AbstractNamedObject. More...
 
void setPath (@NotNull String path)
 Set the path of this AbstractNamedObject. More...
 
String toString ()
 

Detailed Description

An.

AbstractNamedObject

has a name and tree position source and provides an icon for display.

AbstractNamedObject

is the super class of net.sf.gridarta.model.face.FaceObject and net.sf.gridarta.model.anim.AnimationObject.

Author
Christian Hujer

Definition at line 32 of file NamedObject.java.

Member Function Documentation

◆ getDisplayIconName()

String net.sf.gridarta.model.data.NamedObject.getDisplayIconName ( )

Returns the face name of the display icon for this AbstractNamedObject.

Returns
the face name

Implemented in net.sf.gridarta.model.face.DefaultFaceObject, and net.sf.gridarta.model.anim.DefaultAnimationObject.

◆ getName()

String net.sf.gridarta.model.data.NamedObject.getName ( )

Get the name of this AbstractNamedObject.

The name should be of user presentable but 100% machine processable nature, means it must be usable for reverse lookup of this AbstractNamedObject in Maps. For faces, the name should be the face name. For animations, the name should be the animation name. For arch objects, the name should be the arch name (definitely not the title).

Returns
name of this AbstractNamedObject

Implemented in net.sf.gridarta.model.anim.DefaultAnimationObject, and net.sf.gridarta.model.face.DefaultFaceObject.

Referenced by net.sf.gridarta.model.data.AbstractNamedObject.compareTo(), net.sf.gridarta.model.data.AbstractNamedObject.equals(), net.sf.gridarta.model.data.AbstractNamedObject.hashCode(), and net.sf.gridarta.model.data.AbstractNamedObject.toString().

+ Here is the caller graph for this function:

◆ getPath()

String net.sf.gridarta.model.data.NamedObject.getPath ( )

Get the path of this AbstractNamedObject.

The path should be of user presentable but 100% machine processable nature. The path must be usable for creating a tree for this AbstractNamedObject. The path returned by this method does not include the name of the object. The path separator must be "/" independently of the underlying operating system.

Returns
path of this AbstractNamedObject
See also
#setPath(String)

Implemented in net.sf.gridarta.model.data.AbstractNamedObject.

Referenced by net.sf.gridarta.gui.utils.TreeChooseAction.actionPerformed(), net.sf.gridarta.model.data.NamedTreeNode<?>.append(), net.sf.gridarta.model.io.AbstractArchetypeParser< G, A, R, ?>.parseAnim(), net.sf.gridarta.model.io.AnimationObjectsReader.processAnimationLine(), net.sf.gridarta.gui.data.NamedObjectsUtils.showNodeChooserDialog(), and net.sf.gridarta.model.resource.AbstractFilesResourcesReaderTest.testAnimationPaths().

+ Here is the caller graph for this function:

◆ setPath()

void net.sf.gridarta.model.data.NamedObject.setPath ( @NotNull String  path)

Set the path of this AbstractNamedObject.

Parameters
pathnew path for this AbstractNamedObject
See also
getPath()

Implemented in net.sf.gridarta.model.data.AbstractNamedObject.

◆ toString()

String net.sf.gridarta.model.data.NamedObject.toString ( )

The documentation for this interface was generated from the following file: