Class VisitTarget

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    Direct Known Subclasses:
    VisitComponent, VisitEntityListRow, VisitRegions, VisitUIComponent

    public abstract class VisitTarget
    extends java.lang.Object
    implements java.io.Serializable, java.lang.Cloneable
    VisitTarget is an execute or render target in processing JSF life cycle.
    Since:
    4.0
    See Also:
    Serialized Form
    • Field Detail

      • PERSISTENCE_DATA_BEAN

        public static final java.lang.String PERSISTENCE_DATA_BEAN
        backing bean visit target for property PartialBehaviorDef annotation
        See Also:
        Constant Field Values
      • ENTITY_LIST_ROW

        public static final java.lang.String ENTITY_LIST_ROW
        entity list row visit target for property PartialBehaviorDef annotation
        See Also:
        Constant Field Values
      • action

        protected VisitTarget.Action action
        Action to take on client. Default to Update if null.
    • Constructor Detail

      • VisitTarget

        public VisitTarget()
    • Method Detail

      • getAction

        public VisitTarget.Action getAction()
        Get the action to take on client
        Returns:
        Action enum value
      • setAction

        public void setAction​(VisitTarget.Action action)
        Set the action to take on client
        Parameters:
        action - Action enum value
      • getTarget

        public VisitTarget getTarget()
        Get the target for insert, insertBefore and insertAfter.
        Returns:
        the VisitTarget whose clientId will be used to get the target id on client
      • setTarget

        public void setTarget​(VisitTarget target)
        Set the target for the insertBefore and insertAfter.
        Parameters:
        target - the VisitTarget whose clientId will be used to get the target id on client
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • sameClientId

        protected boolean sameClientId​(VisitTarget visitTarget)
        Does this visitTarget has the same client id with the specified visitTarget?
        Parameters:
        visitTarget - VisitTarget
        Returns:
        true if they have the same client id
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getClientId

        public java.lang.String getClientId()
        Get clientId. clientId may not be known until the processing of corresponding component.
        Returns:
        client id
      • setClientId

        public void setClientId​(java.lang.String clientId)
        Set client id
        Parameters:
        clientId - client id
      • getComponent

        public abstract Component getComponent()
        Get the component that maps to this VisitTarget
        Returns:
        component
      • isSubtreeTarget

        public boolean isSubtreeTarget​(VisitTarget visitTarget)
        Check if the visitTarget is a subtree target of this visitTarget.
        Parameters:
        visitTarget - subtree target to check
        Returns:
        true if it is a subtree(descendant) target
      • clone

        public VisitTarget clone()
                          throws java.lang.CloneNotSupportedException
        Overrides:
        clone in class java.lang.Object
        Throws:
        java.lang.CloneNotSupportedException