An XPage As A Tree
Apr 1, 2014, 11:05 PM
I'd like to take a blog post or two to discuss an aspect of XPages that isn't directly applicable to normal XPage development, but which can be a conceptual shift that causes a lot of things to fall into place: the tree nature of an XPage. This has nothing to do with Java, SSJS, beans, or JSF phases. It barely even has much at all to do with web pages.
You've likely heard that XPages aren't really XML - that they're actually Java, created from the "simpler" XML you write. This is true, and it drives home the important point that an NSF is now best viewed as a Java "enterprise" application. However, this isn't actually the best way to look at it; the best way is that an XPage is a tree of objects.
If you've had a Computer Science education, you'll know the tree as one of the foundational data structures used in almost all programming. If you haven't and you're not familiar with trees, it will pay tremendously to learn a bit about it - most sources I've found are either painfully mathy (like Wikipedia's article) or tied to the instruction of a specific language (often a Lisp dialect), but this page of a Python tutorial looks promising. This tree nature helps explain why XML is the tool of choice for writing XPages: XML is a tree-description language.
So an XPage is a tree. Specifically, it's a tree of user-interface objects, each of which contains methods, properties, events, and zero or more child objects. Let's take an example XPage, using ExtLib controls because they are more descriptive:
<?xml version="1.0" encoding="UTF-8"?> <xp:view xmlns:xp="http://www.ibm.com/xsp/core" xmlns:xe="http://www.ibm.com/xsp/coreex" pageTitle="Test Page"> <xe:formTable formTitle="Some Form"> <xe:formRow label="Field One"> <xp:inputText/> </xe:formRow> <xe:formRow label="Field Two"> <xp:radioGroup> <xp:selectItem itemLabel="Foo"/> <xp:selectItem itemLabel="Bar"/> </xp:radioGroup> </xe:formRow> </xe:formTable> <xp:button value="Click Me"/> </xp:view>
Ignore your default impulse to think "ah, I know what that looks like!". At this point, it doesn't "look like" anything, other than:
UIViewRootEx2 (pageTitle="Test Page")
UIFormTable (formTitle="Some Form")
UIFormLayoutRow (label="Field One")
UIFormLayoutRow (label="Field Two")
- UISelectItemEx (itemLabel="Foo")
- UISelectItemEx (itemLabel="Bar")
- UIFormLayoutRow (label="Field One")
- XspCommandButton (value="Click Me")
- UIFormTable (formTitle="Some Form")
The fact that it will eventually be rendered as a OneUI HTML form table won't come into play until renderers are involved (which will be a likely followup post). For now, it's best to think of this as a hierarchical description of a user interface in the abstract. At this point, the only thing standing between the XML code above and looking like this is a nontrivial amount of work:
This also helps conceptualize a specific user's page state. When a user starts interaction with a page, what happens is that the server tracks down the page root class that corresponds with the requested page and asks it to create itself and any applicable children. So you end up with any number of these object trees floating around, each corresponding to an individual interaction session (in our case, a loaded page in a browser tab, but you could also think of it as a loaded process of an application). Interacting with the page consists of calling methods on these objects - setValue, click (which is weird), etc. - and causing them to respond and mutate appropriately.
So where does the HTML come in? That's a topic for another post, but the fact that it hasn't entered yet is the point here: XPages are trees of active objects describing a Platonic ideal interface and the framework has a secondary effect of producing HTML.