Class NTxOverflow

java.lang.Object

net.thevpc.ntexup.api.document.style.NTxOverflow

public final class NTxOverflow
extends Object

Declarative policy for the parts of a node's painting that leave its own layout box. Resolved from the NTxPropName.OVERFLOW property (with the NTxPropName.OVERFLOW_MARGIN and NTxPropName.OVERFLOW_FADE modifiers) and applied centrally by the engine, so any node type can opt in without writing custom code.

The crop box is the node's own bounds inflated on each side by the configured margin. A positive margin lets a controlled amount of overflow be shown; a negative one insets the crop inside the bounds.

• NTxOverflow.Mode.VISIBLE - default, nothing is cropped.
• NTxOverflow.Mode.HIDDEN/NTxOverflow.Mode.CLIP - hard crop at the crop box.
• NTxOverflow.Mode.FADE - crop at the crop box with a soft alpha feather of fadeTop()/fadeRight()/fadeBottom()/ fadeLeft() pixels ending at the crop-box edge, so the content dissolves instead of ending abruptly.

Overflow is purely visual: like CSS overflow it never changes the node's measured size or position.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NTxOverflow.Mode

Field Summary

Fields

Modifier and Type	Field	Description
static final NTxOverflow	VISIBLE	Shared no-op instance: nothing is cropped.

Constructor Summary

Constructors

Constructor	Description
NTxOverflow(NTxOverflow.Mode mode, double top, double right, double bottom, double left, double fadeTop, double fadeRight, double fadeBottom, double fadeLeft)

Method Summary

Modifier and Type	Method	Description
double	bottom()
NTxBounds2D	clipBounds(NTxBounds2D bounds)	Same as clipShape(NTxBounds2D) but as bounds.
Shape	clipShape(NTxBounds2D bounds)	The rectangle the node is cropped to: its bounds inflated by the margins.
double	fadeBottom()
double	fadeLeft()
double	fadeRight()
double	fadeTop()
boolean	isFade()
boolean	isVisible()
double	left()
NTxOverflow.Mode	mode()
double	right()
double	top()

Methods inherited from class Object

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

Field Details

VISIBLE

public static final NTxOverflow VISIBLE

Shared no-op instance: nothing is cropped.

Constructor Details

NTxOverflow

public NTxOverflow(NTxOverflow.Mode mode,
 double top,
 double right,
 double bottom,
 double left,
 double fadeTop,
 double fadeRight,
 double fadeBottom,
 double fadeLeft)

Method Details

mode

public NTxOverflow.Mode mode()

isVisible

public boolean isVisible()

isFade

public boolean isFade()

top

public double top()

right

public double right()

bottom

public double bottom()

left

public double left()

fadeTop

public double fadeTop()

fadeRight

public double fadeRight()

fadeBottom

public double fadeBottom()

fadeLeft

public double fadeLeft()

clipShape

public Shape clipShape(NTxBounds2D bounds)

The rectangle the node is cropped to: its bounds inflated by the margins.

clipBounds

public NTxBounds2D clipBounds(NTxBounds2D bounds)

Same as clipShape(NTxBounds2D) but as bounds.