Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> arranger >> jarl >> [ base overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.arranger.jarl.base
Class BaseJarlObject  

java.lang.Object
  com.arranger.jarl.base.BaseJarlObject

All Implemented Interfaces:

java.lang.Cloneable, IJarlObject

Direct Known Subclasses:

BaseTimedJarlObject

---

public abstract class BaseJarlObject

extends java.lang.Object

implements IJarlObject

BaseJarlObject created on Feb 26, 2003

---

Field Summary
protected  Time	m_cachedTime
protected  java.lang.String	m_className
protected  org.w3c.dom.Element	m_configElement
protected  boolean	m_useAbsoluteTime
protected  int	m_zOrder

 

Constructor Summary

BaseJarlObject()

 

Method Summary
protected  void	addJarlObjectInfo(IJarlObjectInfo jarlObjectInfo)           Override this, and for every field that you're using, call populateInfo(com.arranger.jarl.base.IJarlObjectInfo, java.lang.String, java.lang.String, com.arranger.jarl.base.IJarlObjectInfo.IJarlObjectDisplay) 55 for example: populateInfo(jarlObjectInfo, "zOrder", "Z-Order", JarlInfoUtil.PRIMITIVE_DISPLAY);
java.lang.Object	clone()           This method may be called to create a new copy of the Object.
org.w3c.dom.Element	getConfigElement()
IJarlObjectInfo	getJarlObjectInfo()
protected  java.lang.String	getName()
int	getZOrder()
void	init(IContext context, org.w3c.dom.Element element)           Initialize this object
protected  void	initAttributes(IContext context)           Always remember some attrs might not be there
void	initDef(IContext context, org.w3c.dom.Element element)           Initialize this object
protected  IJarlObjectInfo	populateInfo(IJarlObjectInfo jarlObjectInfo, java.lang.String fieldName, java.lang.String displayName, IJarlObjectInfo.IJarlObjectDisplay jarlObjectDisplay)           for example: populateInfo(jarlObjectInfo, "zOrder", "Z-Order", JarlInfoUtil.PRIMITIVE_DISPLAY);
void	postCheckTime(IContext context)
void	preCheckTime(IContext context)           Some object need the absolute times, not the relative times
void	setZOrder(int zOrder)           Set the zOrder of this object

 

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

m_configElement

protected org.w3c.dom.Element m_configElement

---

m_zOrder

protected int m_zOrder

---

m_useAbsoluteTime

protected boolean m_useAbsoluteTime

---

m_className

protected java.lang.String m_className

---

m_cachedTime

protected transient Time m_cachedTime

Constructor Detail

BaseJarlObject

public BaseJarlObject()

Method Detail

init

public void init(IContext context,
                 org.w3c.dom.Element element)

Initialize this object

Specified by:

init in interface IJarlObject

---

initDef

public void initDef(IContext context,
                    org.w3c.dom.Element element)

Initialize this object

---

preCheckTime

public void preCheckTime(IContext context)

Description copied from interface: IJarlObject

Some object need the absolute times, not the relative times

Specified by:

preCheckTime in interface IJarlObject

---

postCheckTime

public void postCheckTime(IContext context)

Specified by:

postCheckTime in interface IJarlObject

---

getZOrder

public int getZOrder()

Specified by:

getZOrder in interface IJarlObject

---

setZOrder

public void setZOrder(int zOrder)

Set the zOrder of this object

Specified by:

setZOrder in interface IJarlObject

---

clone

public java.lang.Object clone()

Description copied from class: java.lang.Object

This method may be called to create a new copy of the Object. The typical behavior is as follows:

• o == o.clone() is false
• o.getClass() == o.clone().getClass() is true
• o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object)>Object.equals(Object) 55 .

If the Object you call clone() on does not implement java.lang.Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 

Specified by:

clone in interface IJarlObject

---

getConfigElement

public org.w3c.dom.Element getConfigElement()

Specified by:

getConfigElement in interface IJarlObject

---

getJarlObjectInfo

public IJarlObjectInfo getJarlObjectInfo()

Specified by:

getJarlObjectInfo in interface IJarlObject

---

addJarlObjectInfo

protected void addJarlObjectInfo(IJarlObjectInfo jarlObjectInfo)

Override this, and for every field that you're using, call populateInfo(com.arranger.jarl.base.IJarlObjectInfo, java.lang.String, java.lang.String, com.arranger.jarl.base.IJarlObjectInfo.IJarlObjectDisplay) 55 for example: populateInfo(jarlObjectInfo, "zOrder", "Z-Order", JarlInfoUtil.PRIMITIVE_DISPLAY);

---

initAttributes

protected void initAttributes(IContext context)

Always remember some attrs might not be there

---

getName

protected java.lang.String getName()

---

populateInfo

protected IJarlObjectInfo populateInfo(IJarlObjectInfo jarlObjectInfo,
                                       java.lang.String fieldName,
                                       java.lang.String displayName,
                                       IJarlObjectInfo.IJarlObjectDisplay jarlObjectDisplay)

for example: populateInfo(jarlObjectInfo, "zOrder", "Z-Order", JarlInfoUtil.PRIMITIVE_DISPLAY);

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> arranger >> jarl >> [ base overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---