Class Box

src/main/java/fieldbox/boxes/Box.java:35–1018

The fundamental unit in Field --- the box. A Box has properties and it's in a graph structure. Specifically this is a directed, ordered, cyclic graph structure. It's not a multi-graph --- Boxes can only be connected 0 or 1 times. Parent / Child relationships are ordered and the order is main

 * maintained. And the graph can have cycles (it's typically visited in breadth-first without cycles).
 * <p>
 * Much of the time properties are looked up in the graph in breadth first fashion either "upwards" (towards parents) or less-often downwards (collecting over all children).
 */
public class Box implements fieldlinker.AsMap, HandlesCompletion {

	static public final Dict.Prop<String> name = new Dict.Prop<>("name").type()
		.toCanon()
		.doc("the name of this box");
	static public final Dict.Prop<Rect> frame = new Dict.Prop<>("frame").type()
		.toCanon()
		.doc("the rectangle that this box occupies").set(IO.persistent, true).set(IO.perDocument, true);
	static public final Dict.Prop<Number> depth = new Dict.Prop<>("depth").type()
		.toCanon()
		.doc("provides a completely cosmetic 'z' coordinate for this box. Visible in VR and on stereo displays.").set(IO.persistent, true).set(IO.perDocument, true);
	static public final Dict.Prop<Boolean> hidden = new Dict.Prop<>("hidden").type()
		.toCanon()
		.doc("set this to true to hide this box (but be careful, for if it's hidden, how will you get it back again?)");

	static public final Dict.Prop<Boolean> decorative = new Dict.Prop<>("decorative").type()
		.toCanon()
		.doc("boxes like arrows and text have this set");

	static public final Dict.Prop<Boolean> undeletable = new Dict.Prop<>("undeletable").type()
		.toCanon()
		.doc("set this to true to make this box not deletable by conventional means");

	static public final Dict.Prop<Predicate<Box>> availableForCompletion = new Dict.Prop<>("availableForCompletion").type()
		.toCanon()
		.doc("provides a `Predicate<Box>` to help decide if a Property should be shown as available for completion").set(Dict.domain, "attributes");


	@HiddenInAutocomplete
	public final Dict properties = new Dict();

	@HiddenInAutocomplete
	public Set<Box> parents = new LinkedHashSet<>();
	@HiddenInAutocomplete
	public Set<Box> children = new LinkedHashSet<>();

	@HiddenInAutocomplete
	public Deque<Box> all = new ArrayDeque<>();

	protected Set<String> knownNonProperties;
	private String __cachedSimpleName = null;
	private long tick = 0;

	@HiddenInAutocomplete
	public boolean disconnected = false;


	public Box() {
		properties.put(IO.id, newID());
		BoxDefaultCode.configure(this);
	}

	@HiddenInAutocomplete
	static public String newID() {
		// ensure CallLogic is loaded
		Dict.Prop<IdempotencyMap<Supplier<Object>>> ignored = Callbacks.main;