1 /*******************************************************************************
2 * Copyright (c) 2007, 2010 Association for Decentralized Information Management
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.browsing.ui.common.viewpoints;
14 import java.util.Collection;
16 import org.simantics.browsing.ui.BuiltinKeys;
17 import org.simantics.browsing.ui.NodeContext;
18 import org.simantics.browsing.ui.PrimitiveQueryUpdater;
19 import org.simantics.browsing.ui.common.NodeContextBuilder;
20 import org.simantics.browsing.ui.common.NodeContextUtil;
21 import org.simantics.browsing.ui.content.Viewpoint;
24 * @author Tuukka Lehtonen
26 public abstract class ViewpointStub implements Viewpoint {
28 protected NodeContext[] children = Viewpoint.PENDING_CHILDREN;
29 protected Boolean hasChildren = Viewpoint.PENDING_HAS_CHILDREN;
31 final public void setChildren(PrimitiveQueryUpdater updater, NodeContext[] children) {
34 throw new NullPointerException(this + ": null children produced by " + getClass().getName());
36 final NodeContext[] currentChildren = this.children;
38 updater.execFromQuery(new Runnable() {
42 for(NodeContext c : children) updater.incRef(c);
43 for(NodeContext c : currentChildren) updater.decRef(c);
47 this.children = children;
50 public void setHasChildren(Boolean hasChildren) {
52 throw new NullPointerException(this + ": null hasChildren produced by " + getClass().getName());
53 this.hasChildren = hasChildren;
57 * A utility method for transforming an array of objects into an
58 * INodeContext array which is the return value of a ViewpointFactory.
61 * The INodeContext's are constructed using
62 * {@link NodeContextBuilder#buildWithInput(Object)}.
66 * @return the specified children wrapped into simple <code>INodeContext</code>s
68 public NodeContext[] toContextsWithInput(Object... children) {
69 return NodeContextUtil.toContextsWithInput(children);
73 * A utility method for transforming a collection of objects into an
74 * INodeContext array which is the return value of a ViewpointFactory.
77 * The INodeContext's are constructed using
78 * {@link NodeContextBuilder#buildWithInput(Object)}.
82 * @return the specified children wrapped into simple <code>INodeContext</code>s
84 public NodeContext[] toContextsWithInput(Collection<?> children) {
85 return NodeContextUtil.toContextsWithInput(children);
89 * A utility method for transforming a collection of objects into an
90 * INodeContext array which is the return value of a ViewpointFactory.
93 * The INodeContext's are constructed using the specified factory.
97 * @return the specified children wrapped into INodeContext's through the
98 * specified <code>factory</code>
100 public NodeContext[] toContexts(Collection<?> children, NodeContextUtil.NodeContextFactory factory) {
101 return NodeContextUtil.toContexts(children, factory);
107 * @return input of the specified class
108 * @throws ClassCastException if the input class does not match the
110 * @throws NullPointerException if the input is null
112 @SuppressWarnings("unchecked")
113 protected <T> T getInput(NodeContext context) {
114 Object o = context.getConstant(BuiltinKeys.INPUT);
116 throw new NullPointerException("null input");
123 * @return <code>null</code> if input is <code>null</code> or if the class
126 @SuppressWarnings("unchecked")
127 protected <T> T tryGetInput(NodeContext context, Class<T> clazz) {
128 Object o = context.getConstant(BuiltinKeys.INPUT);
129 if (o != null && clazz.isInstance(o))