Package org.polyfrost.polyui.operations

Interface ComponentOp

  • All Implemented Interfaces:
    
public interface ComponentOp

    component operations represent simple procedures that are ran before and after every render cycle. They can support animations and verification.

    Since:

    1.6.1

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public abstract class ComponentOp.Animatable

      Class to represent an operation that can be applied on a component that modifies it in some way.

      It is applied before and after rendering, for example a Move, Resize, or Rotate operation, or a transition.

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Unit apply() Apply the operation, this is called before the component is rendered.
      Boolean unapply() Unapply the operation.
      Boolean verify() override this function to verify that this operation is valid, which is run before it is applied.
      Boolean exclusive() If this is true, when this drawable operation is attempted to be added, if one is already present, instead of replacing it, it will be ignored.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • apply

         abstract Unit apply()

        Apply the operation, this is called before the component is rendered.

      • unapply

         Boolean unapply()

        Unapply the operation. this is called after the component is rendered.

        return true to instantly remove this operation from the component.

      • verify

         Boolean verify()

        override this function to verify that this operation is valid, which is run before it is applied. (default: always true)

        Returns:

        true if this operation is deemed to be valid.

        Since:

        1.1.1

      • exclusive

         Boolean exclusive()

        If this is true, when this drawable operation is attempted to be added, if one is already present, instead of replacing it, it will be ignored.

        Since:

        1.5.0