Class Keep


  • public final class Keep
    extends java.lang.Object
    Object representing a keep constraint, corresponding to the XSL-FO keep properties.
    • Field Detail

      • STRENGTH_AUTO

        private static final int STRENGTH_AUTO
        The integer value for "auto" keep strength.
        See Also:
        Constant Field Values
      • STRENGTH_ALWAYS

        private static final int STRENGTH_ALWAYS
        The integer value for "always" keep strength.
        See Also:
        Constant Field Values
      • KEEP_AUTO

        public static final Keep KEEP_AUTO
        keep auto
      • KEEP_ALWAYS

        public static final Keep KEEP_ALWAYS
        keep always
      • strength

        private int strength
      • context

        private int context
    • Constructor Detail

      • Keep

        private Keep​(int strength,
                     int context)
    • Method Detail

      • getKeepStrength

        private static int getKeepStrength​(Property keep)
      • getKeep

        public static Keep getKeep​(KeepProperty keepProperty)
        Obtain a Keep instance corresponding to the given KeepProperty
        Parameters:
        keepProperty - the KeepProperty
        Returns:
        a new instance corresponding to the given property
      • update

        private void update​(Property keep,
                            int context)
      • isAuto

        public boolean isAuto()
        Returns:
        true if the keep property was specified as "auto"
      • getPenalty

        public int getPenalty()
        Returns:
        the penalty value corresponding to the strength of this Keep
      • getKeepContextPriority

        private static int getKeepContextPriority​(int context)
      • compare

        public Keep compare​(Keep other)
        Compare this Keep instance to another one, and return the stronger one if the context is the same
        Parameters:
        other - the instance to compare to
        Returns:
        the winning Keep instance
      • toString

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