Class AbstractHtml5SharedObject

java.lang.Object
com.webfirmframework.wffweb.tag.html.model.AbstractHtml5SharedObject
All Implemented Interfaces:
Serializable

public final class AbstractHtml5SharedObject extends Object implements Serializable
Since:
1.0.0
See Also:
  • Constructor Details

    • AbstractHtml5SharedObject

      public AbstractHtml5SharedObject(AbstractHtml rootTag)
  • Method Details

    • getNewDataWffId

      public DataWffId getNewDataWffId(Object accessObject)
      Parameters:
      accessObject -
      Returns:
      unique data-wff-id attribute
      Since:
      2.0.0
    • getLock

      public ReentrantReadWriteLock getLock(Object accessObject)
      Parameters:
      accessObject -
      Returns:
      the ReadWriteLock lock
      Since:
      3.0.1
    • getLastDataWffId

      public int getLastDataWffId(Object accessObject)
    • isChildModified

      public boolean isChildModified()
      Returns:
      the childModified true if any of the children has been modified
      Since:
      1.0.0
    • setChildModified

      @Deprecated public void setChildModified(boolean childModified)
      Deprecated.
      it does nothing since 3.0.19
      set true if any of the children has been modified.
      NB:- it's for internal use
      Parameters:
      childModified - the childModified to set
      Since:
      1.0.0
    • setChildModified

      public void setChildModified(boolean childModified, Object accessObject)
      set true if any of the children has been modified.
      NB:- it's for internal use
      Parameters:
      childModified - the childModified to set
      accessObject - access object
      Since:
      3.0.19
    • getRebuiltTags

      @Deprecated public Set<AbstractTagBase> getRebuiltTags(Object accessObject)
      Deprecated.
      only for internal use currently it's not used anywhere. Needs to remove this method later.
      gets the set containing the objects which are rebuilt after modified by its AbstractTagBase method. NB:- only for internal use. currently it's not used anywhere
      Parameters:
      accessObject -
      Returns:
      the rebuiltTags
      Since:
      1.0.0
    • getChildTagAppendListener

      public ChildTagAppendListener getChildTagAppendListener(Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      accessObject -
      Returns:
      the childTagAppendListener
    • setChildTagAppendListener

      public void setChildTagAppendListener(ChildTagAppendListener childTagAppendListener, Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      childTagAppendListener - the childTagAppendListener to set
      accessObject -
    • getChildTagRemoveListener

      public ChildTagRemoveListener getChildTagRemoveListener(Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      accessObject -
      Returns:
      the childTagRemoveListener
    • setChildTagRemoveListener

      public void setChildTagRemoveListener(ChildTagRemoveListener childTagRemoveListener, Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      childTagRemoveListener - the childTagRemoveListener to set
      accessObject -
    • getAttributeAddListener

      public AttributeAddListener getAttributeAddListener(Object accessObject)
      Parameters:
      accessObject -
      Returns:
      the attributeAddListener
    • setAttributeAddListener

      public void setAttributeAddListener(AttributeAddListener attributeAddListener, Object accessObject)
      Parameters:
      attributeAddListener - the attributeAddListener to set
      accessObject -
    • getAttributeRemoveListener

      public AttributeRemoveListener getAttributeRemoveListener(Object accessObject)
      Parameters:
      accessObject -
      Returns:
      the attributeRemoveListener
    • setAttributeRemoveListener

      public void setAttributeRemoveListener(AttributeRemoveListener attributeRemoveListener, Object accessObject)
      Parameters:
      attributeRemoveListener - the attributeRemoveListener to set
      accessObject -
    • getInnerHtmlAddListener

      public InnerHtmlAddListener getInnerHtmlAddListener(Object accessObject)
      Parameters:
      accessObject -
      Returns:
      the innerHtmlAddListener
    • setInnerHtmlAddListener

      public void setInnerHtmlAddListener(InnerHtmlAddListener innerHtmlAddListener, Object accessObject)
      Parameters:
      innerHtmlAddListener - the innerHtmlAddListener to set
      accessObject -
    • getTagByWffId

      public Map<String,AbstractHtml> getTagByWffId(Object accessObject)
      Parameters:
      accessObject -
      Returns:
      the map containing wffid and tag
      Since:
      2.0.0
    • initTagByWffId

      public Map<String,AbstractHtml> initTagByWffId(Object accessObject)
      Parameters:
      accessObject -
      Returns:
      the map containing wffid and tag
      Since:
      2.0.0
    • getValueChangeListener

      public AttributeValueChangeListener getValueChangeListener(Object accessObject)
      NB:- This listener is used for internal purpose and should not be consumed. Instead, use addValueChangeListener and getValueChangeListeners methods.
      Parameters:
      accessObject - access object of this method
      Returns:
      the valueChangeListener
    • setValueChangeListener

      public void setValueChangeListener(AttributeValueChangeListener valueChangeListener, Object accessObject)
      NB:- This listener is used for internal purpose and should not be consumed. Instead, use addValueChangeListener and getValueChangeListeners methods.
      Parameters:
      valueChangeListener - the valueChangeListener to set
      accessObject - access object of this method
    • getInsertBeforeListener

      @Deprecated public InsertBeforeListener getInsertBeforeListener(Object accessObject)
      Deprecated.
      will be removed in future as there is a better implementation with InsertTagsBeforeListener
      NB:- This method is for only for internal use
      Parameters:
      accessObject -
      Returns:
      the insertBeforeListener
      Since:
      2.1.1
    • setInsertBeforeListener

      @Deprecated public void setInsertBeforeListener(InsertBeforeListener insertBeforeListener, Object accessObject)
      Deprecated.
      will be removed in future as there is a better implementation with InsertTagsBeforeListener
      NB:- This method is for only for internal use
      Parameters:
      insertBeforeListener - the insertBeforeListener to set
      accessObject -
      Since:
      2.1.1
    • getReplaceListener

      public ReplaceListener getReplaceListener(Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      accessObject -
      Returns:
      the replaceListener
      Since:
      3.0.7
    • setReplaceListener

      public void setReplaceListener(ReplaceListener replaceListener, Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      replaceListener - the replaceListener to set
      accessObject -
      Since:
      3.0.7
    • getInsertTagsBeforeListener

      public InsertTagsBeforeListener getInsertTagsBeforeListener(Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      accessObject -
      Returns:
      the insertTagsBeforeListener
      Since:
      3.0.7
    • setInsertTagsBeforeListener

      public void setInsertTagsBeforeListener(InsertTagsBeforeListener insertTagsBeforeListener, Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      insertTagsBeforeListener - the insertTagsBeforeListener to set
      accessObject -
      Since:
      3.0.7
    • getInsertAfterListener

      public InsertAfterListener getInsertAfterListener(Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      accessObject -
      Returns:
      the insertAfterListener
      Since:
      3.0.7
    • setInsertAfterListener

      public void setInsertAfterListener(InsertAfterListener insertAfterListener, Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      insertAfterListener - the insertAfterListener to set
      accessObject -
      Since:
      3.0.7
    • setWffBMDataDeleteListener

      public void setWffBMDataDeleteListener(WffBMDataDeleteListener wffBMDataDeleteListener, Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      wffBMDataDeleteListener - the wffDataDeleteListener to set
      accessObject -
      Since:
      2.1.8
    • setWffBMDataUpdateListener

      public void setWffBMDataUpdateListener(WffBMDataUpdateListener wffBMDataUpdateListener, Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      wffBMDataUpdateListener - the wffDataUpdateListener to set
      accessObject -
      Since:
      2.1.8
    • getWffBMDataDeleteListener

      public WffBMDataDeleteListener getWffBMDataDeleteListener(Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      accessObject -
      Returns:
      the insertBeforeListener
      Since:
      2.1.8
    • getWffBMDataUpdateListener

      public WffBMDataUpdateListener getWffBMDataUpdateListener(Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      accessObject -
      Returns:
      the wffBMDataUpdateListener
      Since:
      2.1.8
    • getRootTag

      public AbstractHtml getRootTag()
      Returns:
      the rootTag set through the constructor.
      Since:
      2.1.11
    • getSharedData

      public Object getSharedData()
      Gets the object which is accessible in all of this tag hierarchy.
      Returns:
      the sharedData object set by setSharedData method. This object is same across all of this tag hierarchy.
      Since:
      2.1.11
    • setSharedData

      public void setSharedData(Object sharedData)
      Sets the object which will be accessible by getSharedData method in all of this tag hierarchy. setData sets an object for the specific tag but setSharedData sets an object for all of the tag hierarchy.
      Parameters:
      sharedData - the object to access through all of this tag hierarchy.
      Since:
      2.1.11
    • setSharedDataIfNull

      public boolean setSharedDataIfNull(Object sharedData)
      Parameters:
      sharedData -
      Returns:
      true if set or false if it already had a value
      Since:
      3.0.1
    • setPushQueue

      public void setPushQueue(PushQueue pushQueue, Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      pushQueue - the BrowserPage push queue to set
      accessObject -
    • getPushQueue

      public PushQueue getPushQueue(Object accessObject)
      NB:- This method is for only for internal use
      Returns:
      the the push queue of BrowserPage
    • setActiveWSListener

      public void setActiveWSListener(boolean activeWSListener, Object accessObject)
      NB:- This method is for only for internal use
      Parameters:
      activeWSListener - true if BrowserPage.wsListener != null otherwise false
      accessObject -
    • isActiveWSListener

      public boolean isActiveWSListener()
      NB:- This method is for only for internal use
      Returns:
      true if BrowserPage.wsListener != null otherwise false
    • objectId

      public final ObjectId objectId()
      Note: only for internal use.
      Returns:
      the object id for this object
      Since:
      3.0.15 returns long value type, 3.0.19 returns ObjectId value type