Documentation for more classes.

This commit is contained in:
Jindra Petřík
2024-08-06 00:07:57 +02:00
parent 0f69896187
commit 25930a894e
6 changed files with 444 additions and 91 deletions

View File

@@ -20,30 +20,75 @@ import java.io.IOException;
import java.io.OutputStream;
/**
*
* An item that can be loaded(opened) in FFDec.
* For example SWF or ABC.
* @author JPEXS
*/
public interface Openable extends TreeItem {
/**
* Gets file title.
* @return
*/
public String getFileTitle();
/**
* Gets title with path from root (like in nested SWFs)
* @return
*/
public String getShortPathTitle();
/**
* Gets short file name based on file title and file.
* @return
*/
public String getShortFileName();
/**
* Gets opened file.
* @return File or null
*/
public String getFile();
/**
*
* @return
*/
public String getTitleOrShortFileName();
/**
* Gets title of the file or short filename.
* @return file title or base file name when file title is null or "_" when file is null too
*/
public String getFullPathTitle();
/**
* Sets OpenableList which this Openable resides.
* @param openableList
*/
public void setOpenableList(OpenableList openableList);
/**
* Gets OpenableList which this Openable resides.
* @return
*/
public OpenableList getOpenableList();
/**
* Saves Openable to stream.
* @param os
* @throws IOException
*/
public void saveTo(OutputStream os) throws IOException;
/**
* Sets file.
* @param file
*/
public void setFile(String file);
/**
* Clears modified flag from this item and all subitems.
*/
public void clearModified();
}

View File

@@ -17,12 +17,20 @@
package com.jpexs.decompiler.flash.treeitems;
/**
*
* Basic interface for an item in the tag tree.
* @author JPEXS
*/
public interface TreeItem {
/**
* Gets openable which this item resides.
* @return
*/
public Openable getOpenable();
/**
* Gets modified flag.
* @return
*/
public boolean isModified();
}