mcardle 2005/04/27 13:56:58 CEST
Modified files:
core/src/java/org/jahia/data JahiaData.java
core/src/java/org/jahia/data/containers JahiaContainer.java
JahiaContainerList.java
core/src/java/org/jahia/data/fields JahiaField.java
core/src/java/org/jahia/gui GuiBean.java HTMLToolBox.java
core/src/java/org/jahia/settings SettingsBean.java
Log:
Merged javadoc comments from Template Guide's -now deleted- Jahia API Chapter
Revision Changes Path
1.3 +13 -1 jahia/core/src/java/org/jahia/data/JahiaData.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/core/src/java/org/jahia/data/JahiaData.java.diff?r1=1.2&r2=1.3&f=h
1.4 +19 -5
jahia/core/src/java/org/jahia/data/containers/JahiaContainer.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/core/src/java/org/jahia/data/containers/JahiaContainer.java.diff?r1=1.3&r2=1.4&f=h
1.3 +1 -0
jahia/core/src/java/org/jahia/data/containers/JahiaContainerList.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/core/src/java/org/jahia/data/containers/JahiaContainerList.java.diff?r1=1.2&r2=1.3&f=h
1.7 +30 -6 jahia/core/src/java/org/jahia/data/fields/JahiaField.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/core/src/java/org/jahia/data/fields/JahiaField.java.diff?r1=1.6&r2=1.7&f=h
1.5 +13 -10 jahia/core/src/java/org/jahia/gui/GuiBean.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/core/src/java/org/jahia/gui/GuiBean.java.diff?r1=1.4&r2=1.5&f=h
1.8 +26 -13 jahia/core/src/java/org/jahia/gui/HTMLToolBox.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/core/src/java/org/jahia/gui/HTMLToolBox.java.diff?r1=1.7&r2=1.8&f=h
1.13 +2 -2 jahia/core/src/java/org/jahia/settings/SettingsBean.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/core/src/java/org/jahia/settings/SettingsBean.java.diff?r1=1.12&r2=1.13&f=h
Index: JahiaData.java
===================================================================
RCS file:
/home/cvs/repository/jahia/core/src/java/org/jahia/data/JahiaData.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- JahiaData.java 15 Jun 2004 16:27:09 -0000 1.2
+++ JahiaData.java 27 Apr 2005 11:56:56 -0000 1.3
@@ -139,14 +139,26 @@
/***
- * accessor methods
+ * returns an object containing all the page parameters
* EV 30.10.2000
*
*/
public ParamBean params() { return jParams; }
+ /***
+ * returns the current page
+ */
public JahiaPage page() { return jParams.getPage();
} // for upward compatibility
+ /***
+ * returns the field set of the current page
+ */
public JahiaFieldSet fields() { return fieldSet; }
+ /***
+ * returns the container set of the current page
+ */
public JahiaContainerSet containers() { return containerSet; }
+ /***
+ * returns an object allowing to retrieve paths and to draw links
+ */
public GuiBean gui() { return guiBean; }
// end accessor methods
Index: JahiaContainer.java
===================================================================
RCS file:
/home/cvs/repository/jahia/core/src/java/org/jahia/data/containers/JahiaContainer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- JahiaContainer.java 9 Dec 2004 11:19:45 -0000 1.3
+++ JahiaContainer.java 27 Apr 2005 11:56:56 -0000 1.4
@@ -142,7 +142,7 @@
}
/***
- * accessor methods
+ * returns the container id
* EV 24.11.2000
*
*/
@@ -153,11 +153,18 @@
public final int getJahiaID () {
return jahiaID;
}
-
+ /**
+ * returns the id of the site which contains the container.
+ * @return int
+ */
public final int getSiteID () {
return jahiaID;
} //FIXME_MULTISITE Hollis jahiaID or siteID ?
+ /**
+ * returns the id of the page which contains the container
+ * @return int
+ */
public final int getPageID () {
return pageID;
}
@@ -165,7 +172,10 @@
public final int getListID () {
return listID;
}
-
+ /**
+ * returns the container rank.
+ * @return int
+ */
public final int getRank () {
return rank;
}
@@ -199,7 +209,10 @@
}
return acl;
}
-
+ /**
+ * returns the field list.
+ * @return Enumeration
+ */
public Enumeration getFields () {
checkProxy(ContainerFactoryProxy.LOAD_FIELDS);
return fields.elements();
@@ -470,6 +483,7 @@
//-------------------------------------------------------------------------
/***
* get a field by its fieldname
+ * (returns the JahiaField object of name �fieldName" contained in this
container)
*
* @param fieldName the field name
*
@@ -492,7 +506,7 @@
//-------------------------------------------------------------------------
/***
* get a field by its id
- *
+ * (returns the JahiaField object of id �fieldID" contained in this
container)
* @param fieldID the field ID
*
* @exception JahiaException
Index: JahiaContainerList.java
===================================================================
RCS file:
/home/cvs/repository/jahia/core/src/java/org/jahia/data/containers/JahiaContainerList.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- JahiaContainerList.java 28 Jul 2004 17:36:15 -0000 1.2
+++ JahiaContainerList.java 27 Apr 2005 11:56:56 -0000 1.3
@@ -155,6 +155,7 @@
//-------------------------------------------------------------------------
/**
+ * returns the container of id �containerId� in the container list
*/
public JahiaContainer getContainer( int index ) throws JahiaException
{
Index: JahiaField.java
===================================================================
RCS file:
/home/cvs/repository/jahia/core/src/java/org/jahia/data/fields/JahiaField.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- JahiaField.java 28 Feb 2005 16:10:16 -0000 1.6
+++ JahiaField.java 27 Apr 2005 11:56:56 -0000 1.7
@@ -123,18 +123,33 @@
}
/**
- * accessor methods
+ * returns the field id.
* EV 31.10.2000
*
*/
public int getID() { return ID; }
public int getJahiaID() { return jahiaID; }
+ /**
+ * returns the id of the site containing the field.
+ */
public int getSiteID() { return jahiaID; }
// FIXME_MULTISITE Hollis humm jahiaID or siteID ?
+ /**
+ * returns the id of the page containing the field.
+ */
public int getPageID() { return pageID; }
public int getFieldDefID() { return fieldDefID; }
public int getctnid() { return ctnid; }
+ /**
+ * returns the field type.
+ */
public int getType() { return fieldType; }
+ /**
+ * returns the type of connection (external or internal).
+ */
public int getConnectType() { return connectType; }
+ /**
+ * returns the field rank.
+ */
public int getRank() { return rank; }
public final int getAclID() { return aclID; }
public int getVersionID() { return versionID; }
@@ -155,7 +170,10 @@
}
return acl;
}
-
+ /**
+ * returns the field object (for non-text fields).
+ * @return Object
+ */
public Object getObject() { return
objectItem; }
public void setID( int ID ) { this.ID = ID;
}
@@ -174,7 +192,10 @@
public void setConnectType( int connectType ) {
registerChange(); this.connectType = connectType; }
public void setObject( Object objectItem ) {
registerChange(); this.objectItem = objectItem; }
// end accessor methods
-
+ /**
+ * returns the field value (only for text fields).
+ * @return String
+ */
public String getValue() {
return fieldValue;
}
@@ -189,14 +210,17 @@
}
/**
- * Sets the internal raw value. This means that the value we set has
never
- * been processed.
+ * returns the value of the raw.
* @return
*/
public String getRawValue() {
return fieldRawValue;
}
-
+ /**
+ * Sets the internal raw value. This means that the value we set has
never
+ * been processed.
+ * @return
+ */
public void setRawValue(String fieldRawValue) {
registerChange();
this.fieldRawValue = fieldRawValue;
Index: GuiBean.java
===================================================================
RCS file:
/home/cvs/repository/jahia/core/src/java/org/jahia/gui/GuiBean.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- GuiBean.java 18 Nov 2004 11:34:00 -0000 1.4
+++ GuiBean.java 27 Apr 2005 11:56:57 -0000 1.5
@@ -115,6 +115,7 @@
//-------------------------------------------------------------------------
/**
+ * returns the URL of the JSP context
*/
public String drawHttpJspContext (HttpServletRequest req){
@@ -145,6 +146,7 @@
/**
+ * returns the URL allowing to switch between normal mode and edition
mode.
* EV 21.11.2000
*
*/
@@ -750,7 +752,7 @@
}
/***
- * drawUsername
+ * returns the current user name.
* JB 25.04.2001
*
*/
@@ -765,6 +767,7 @@
/**
+ * tests if Jahia is in edition mode
* JB 25.04.2001
*/
public boolean isEditMode()
@@ -804,7 +807,7 @@
}
/***
- * isLogged
+ * tests if the current user is logged
* JB 25.04.2001
*
*/
@@ -824,7 +827,7 @@
/***
- * isPageInPath
+ * tests if a page belongs to the current page path
* JB 25.04.2001
*
*/
@@ -866,7 +869,7 @@
/***
- * isNS
+ * tests if the browser is Netscape
* JB 16.05.2001
*
*/
@@ -885,7 +888,7 @@
/***
- * isNS4
+ * tests if the browser is Netscape 4.x.
* JB 16.05.2001
*
*/
@@ -904,7 +907,7 @@
/***
- * isNS6
+ * tests if the browser is Netscape 6.x.
* JB 16.05.2001
*
*/
@@ -921,7 +924,7 @@
/***
- * isIE
+ * tests if the browser is Internet Explorer
* JB 16.05.2001
*
*/
@@ -938,7 +941,7 @@
/***
- * isIE4
+ * tests if the browser is Internet Explorer 4.x.
* JB 16.05.2001
*
*/
@@ -955,7 +958,7 @@
/***
- * isIE5
+ * tests if the browser is Internet Explorer 5.x.
* JB 16.05.2001
*
*/
@@ -1040,7 +1043,7 @@
/***
- * checkWriteAccess
+ * checks if the current user has write access on the current page
* JB 25.04.2001
*
*/
Index: HTMLToolBox.java
===================================================================
RCS file:
/home/cvs/repository/jahia/core/src/java/org/jahia/gui/HTMLToolBox.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- HTMLToolBox.java 8 Dec 2004 11:28:46 -0000 1.7
+++ HTMLToolBox.java 27 Apr 2005 11:56:57 -0000 1.8
@@ -102,7 +102,7 @@
//----------------------------------------------------------------
drawLogin
/**
- *
+ * returns the URL allowing to open the login popup window
* @return
* @throws JahiaException
*/
@@ -138,7 +138,7 @@
//---------------------------------------------------------------
drawLogout
/**
- *
+ * returns the URL allowing to logout
* @return
* @throws JahiaException
*/
@@ -170,7 +170,7 @@
//----------------------------------------------------------
drawUpdateField
/**
- *
+ * returns the URL of the field update window
* @param contentField
* @return
* @throws JahiaException
@@ -197,7 +197,7 @@
}
/**
- *
+ * returns the full link (�<a�>update</a>") used to open the update
field window
* @param theField
* @return
* @throws JahiaException
@@ -221,7 +221,7 @@
// --------------------------------------------------------
drawAddContainer
/**
- *
+ * returns the URL which opens the container add window
* @param contentContainerList
* @return
*/
@@ -286,7 +286,7 @@
//------------------------------------------------------
drawUpdateContainer
/**
- *
+ * returns the URL of the container update window
* @param contentContainerList
* @return
* @throws JahiaException
@@ -350,7 +350,7 @@
}
/**
- *
+ * returns the full link (�<a�>update</a>") used to open the update
container window
* @param theContainer
* @return
* @throws JahiaException
@@ -392,7 +392,7 @@
//------------------------------------------------------
drawDeleteContainer
/**
- *
+ * returns only the URL of the previous window
* @param contentContainer
* @return
* @throws JahiaException
@@ -420,7 +420,7 @@
}
/**
- *
+ * returns the full link (�<a�>delete</a>") used to open the delete
container window
* @param theContainer
* @return
* @throws JahiaException
@@ -615,7 +615,7 @@
//-------------------------------------------------------
drawPageProperties
/**
- *
+ * returns the URL allowing to open the current page properties window
* @return
* @throws JahiaException
*/
@@ -703,14 +703,20 @@
")";
}
- // drawSearchLauncher
+ /**
+ * returns the URL value for the �action� parameter of tag �form�; the
input text field name must be �search�
+ * @return String
+ * @throws JahiaException
+ */
public String drawSearchLauncher ()
throws JahiaException {
//return drawLauncher(
return gui.drawSearchUrl();
}
- // drawAdministrationLauncher
+ /**
+ * returns the URL of the administration page
+ */
// MJ 21.03.2001
public String drawAdministrationLauncher ()
throws JahiaException {
@@ -727,7 +733,11 @@
return gui.drawNewUserRegistrationUrl();
}
- // drawSiteMapLauncher
+ /**
+ * returns the site map page URL
+ * @return String
+ * @throws JahiaException
+ */
public String drawSiteMapLauncher ()
throws JahiaException {
//return drawLauncher(
@@ -735,6 +745,9 @@
}
// drawAddContainerButton
+ /**
+ * returns the full link (�<a�>add</a>") used to open the add popup
+ */
public String drawAddContainerButton (JahiaContainerList
theContainerList)
throws JahiaException {return drawButton(drawAddContainerLauncher(
theContainerList), "add");
Index: SettingsBean.java
===================================================================
RCS file:
/home/cvs/repository/jahia/core/src/java/org/jahia/settings/SettingsBean.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- SettingsBean.java 22 Mar 2005 15:49:54 -0000 1.12
+++ SettingsBean.java 27 Apr 2005 11:56:57 -0000 1.13
@@ -1,4 +1,4 @@
-// $Id: SettingsBean.java,v 1.12 2005/03/22 15:49:54 shuber Exp $
+// $Id: SettingsBean.java,v 1.13 2005/04/27 11:56:57 mcardle Exp $
//
// ____.
// __/\ ______| |__/\. _______
@@ -1012,7 +1012,7 @@
/**
* Used to get the javascript http path.
- *
+ * (returns the URL of the Javascript file needed by Jahia)
* @return The javascript http path.
*/
public String getJsHttpPath() {
