From 02c8f89ce57f797727f7cfe0776a3f5390c745da Mon Sep 17 00:00:00 2001
From: ulrich
Date: Thu, 14 Nov 2024 10:37:06 +0000
Subject: [PATCH] Dokumentation in Arbeit: FileRef fertig dokumentiert, kleinere Anpassungen
---
src/de/uhilger/fm/FileHelper.java | 2
src/de/uhilger/fm/FileRef.java | 67 ++++++++++++++++++++++++++++++++-
2 files changed, 66 insertions(+), 3 deletions(-)
diff --git a/src/de/uhilger/fm/FileHelper.java b/src/de/uhilger/fm/FileHelper.java
index ab753fb..0991985 100644
--- a/src/de/uhilger/fm/FileHelper.java
+++ b/src/de/uhilger/fm/FileHelper.java
@@ -20,7 +20,7 @@
import java.io.File;
/**
- * FileHelper
+ * Hilfsfunktionen fuer die Dateiverwaltung
*
* @author Ulrich Hilger
* @version 1, 04.07.2021
diff --git a/src/de/uhilger/fm/FileRef.java b/src/de/uhilger/fm/FileRef.java
index 11471ef..aa12a2d 100644
--- a/src/de/uhilger/fm/FileRef.java
+++ b/src/de/uhilger/fm/FileRef.java
@@ -18,7 +18,7 @@
package de.uhilger.fm;
/**
- * Datei-Referenz
+ * Einfache Transportklasse fuer eine Datei-Referenz
*
* @author Ulrich Hilger
* @version 1, 11. Mai 2021
@@ -54,43 +54,96 @@
private String miniurl;
private String imgsrc;
+ /**
+ * Den Ausdruck fuer <code>imgsrc</code> ermitteln,
+ * wenn es sich bei der Datei um eine Bilddatei handelt
+ *
+ * @return den imgsrc-Ausdruck
+ */
public String getImgSrc() {
return imgsrc;
}
+ /**
+ * Den Ausdruck fuer <code>imgsrc</code> angeben,
+ * wenn es sich bei der Datei um eine Bilddatei handelt
+ *
+ * @param imgSrc der imgsrc-Ausdruck
+ */
public void setImgSrc(String imgSrc) {
this.imgsrc = imgSrc;
}
-
+ /**
+ * Den URL der Miniaturansicht ermitteln,
+ * wenn es sich bei der Datei um eine Bilddatei handelt
+ *
+ * @return URL der Miniaturansicht
+ */
public String getMiniurl() {
return miniurl;
}
+ /**
+ * Den URL der Miniaturansicht setzen,
+ * wenn es sich bei der Datei um eine Bilddatei handelt
+ *
+ * @param miniurl URL der Miniaturansicht
+ */
public void setMiniurl(String miniurl) {
this.miniurl = miniurl;
}
+ /**
+ * Die CSS-Typ-Klasse fuer diese Datei ermitteln
+ *
+ * @return die CSS-Typ-Klasse dieser Datei
+ */
public String getTypKlasse() {
return typKlasse;
}
+ /**
+ * Die CSS-Typ-Klasse fuer diese Datei setzen
+ *
+ * @param typKlasse die CSS-Typ-Klasse dieser Datei
+ */
public void setTypKlasse(String typKlasse) {
this.typKlasse = typKlasse;
}
+ /**
+ * Den Namen dieser Datei ermitteln
+ *
+ * @return Name dieser Datei
+ */
public String getName() {
return name;
}
+ /**
+ * Den Namen dieser Datei setzen
+ *
+ * @param name Name dieser Datei
+ */
public void setName(String name) {
this.name = name;
}
+ /**
+ * Den Typ dieser Datei ermitteln
+ *
+ * @return 'datei' oder 'ordner'
+ */
public String getTyp() {
return typ;
}
+ /**
+ * Den Typ dieser Datei setzen
+ *
+ * @param typ 'datei' oder 'ordner'
+ */
public void setTyp(String typ) {
this.typ = typ;
switch(typ) {
@@ -106,10 +159,20 @@
}
}
+ /**
+ * Ermitteln, ob es sich bei dieser Datei um ein Bild handelt
+ *
+ * @return true, wenn diese Datei ein Bild ist, false wenn nicht
+ */
public boolean isBild() {
return bild;
}
+ /**
+ * Den Bildindikator fuer diese Dateireferenz setzen
+ *
+ * @param istBild true, wenn diese Datei ein Bild ist, false wenn nicht
+ */
public void setBild(boolean istBild) {
this.bild = istBild;
}
--
Gitblit v1.9.3