X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=bundles%2Forg.simantics.browsing.ui%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fcontent%2FComparableContextFactory.java;h=34d6a50d36d8b07d770337761c61c796a3ed297b;hp=926dabb569e53993c7adaafaacae8ae26eb79e5d;hb=0ae2b770234dfc3cbb18bd38f324125cf0faca07;hpb=24e2b34260f219f0d1644ca7a138894980e25b14 diff --git a/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/ComparableContextFactory.java b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/ComparableContextFactory.java index 926dabb56..34d6a50d3 100644 --- a/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/ComparableContextFactory.java +++ b/bundles/org.simantics.browsing.ui/src/org/simantics/browsing/ui/content/ComparableContextFactory.java @@ -1,45 +1,45 @@ -/******************************************************************************* - * Copyright (c) 2007, 2010 Association for Decentralized Information Management - * in Industry THTH ry. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * VTT Technical Research Centre of Finland - initial API and implementation - *******************************************************************************/ -package org.simantics.browsing.ui.content; - -import org.simantics.browsing.ui.NodeContext; -import org.simantics.browsing.ui.NodeQueryManager; - -/** - * This interface can be used to determine a sorting order for the children of a - * certain node. A single ComparableContextFactory is always used for the - * children of a single parent node, i.e. a single sorting algorithm will always - * be used to sort the children. - * - * @author Antti Villberg - */ -public interface ComparableContextFactory { - - /** - * Constructs {@link ComparableContext} instances from an array of - * {@link NodeContext}s. The input array will be in the order in which the - * viewpoint contributions happened to produce the {@link NodeContext}s in. - * - * @param manager manager for performing the necessary queries to resolve - * the sorting order - * @param parent the parent node of the children. May be used to carry - * constant data to guide the sorting process or just simply ignored. - * @param children the set of child nodes to make into - * {@link ComparableContext} instances - * @return the specified {@link NodeContext}s wrapped into - * {@link ComparableContext}s or null if no sorting is - * to be performed. The result array should be of the same size as - * the input array. - */ - ComparableContext[] create(NodeQueryManager manager, NodeContext parent, NodeContext[] children); - -} +/******************************************************************************* + * Copyright (c) 2007, 2010 Association for Decentralized Information Management + * in Industry THTH ry. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * VTT Technical Research Centre of Finland - initial API and implementation + *******************************************************************************/ +package org.simantics.browsing.ui.content; + +import org.simantics.browsing.ui.NodeContext; +import org.simantics.browsing.ui.NodeQueryManager; + +/** + * This interface can be used to determine a sorting order for the children of a + * certain node. A single ComparableContextFactory is always used for the + * children of a single parent node, i.e. a single sorting algorithm will always + * be used to sort the children. + * + * @author Antti Villberg + */ +public interface ComparableContextFactory { + + /** + * Constructs {@link ComparableContext} instances from an array of + * {@link NodeContext}s. The input array will be in the order in which the + * viewpoint contributions happened to produce the {@link NodeContext}s in. + * + * @param manager manager for performing the necessary queries to resolve + * the sorting order + * @param parent the parent node of the children. May be used to carry + * constant data to guide the sorting process or just simply ignored. + * @param children the set of child nodes to make into + * {@link ComparableContext} instances + * @return the specified {@link NodeContext}s wrapped into + * {@link ComparableContext}s or null if no sorting is + * to be performed. The result array should be of the same size as + * the input array. + */ + ComparableContext[] create(NodeQueryManager manager, NodeContext parent, NodeContext[] children); + +}