org.omnifaces.component.tree.TreeInsertChildren Maven / Gradle / Ivy
Show all versions of omnifaces Show documentation
/*
* Copyright OmniFaces
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package org.omnifaces.component.tree;
import static jakarta.faces.component.visit.VisitHint.SKIP_ITERATION;
import static org.omnifaces.util.Components.getClosestParent;
import static org.omnifaces.util.Components.validateHasNoChildren;
import static org.omnifaces.util.Components.validateHasParent;
import jakarta.faces.component.FacesComponent;
import jakarta.faces.component.UIComponent;
import jakarta.faces.component.visit.VisitCallback;
import jakarta.faces.component.visit.VisitContext;
import jakarta.faces.context.FacesContext;
import jakarta.faces.event.PhaseId;
/**
*
* The <o:treeInsertChildren> is an {@link UIComponent} that represents the insertion point for the
* children of a parent tree node which is represented by {@link TreeNodeItem}.
*
* This component does not allow any children.
*
* @author Bauke Scholtz
* @see TreeNodeItem
*/
@FacesComponent(TreeInsertChildren.COMPONENT_TYPE)
public class TreeInsertChildren extends TreeFamily {
// Public constants -----------------------------------------------------------------------------------------------
/** The component type, which is {@value org.omnifaces.component.tree.TreeInsertChildren#COMPONENT_TYPE}. */
public static final String COMPONENT_TYPE = "org.omnifaces.component.tree.TreeInsertChildren";
// Actions --------------------------------------------------------------------------------------------------------
/**
* Validate the component hierarchy.
* @throws IllegalStateException When there is no parent of type {@link TreeNodeItem}, or when there are any
* children.
*/
@Override
protected void validateHierarchy() {
validateHasParent(this, TreeNodeItem.class);
validateHasNoChildren(this);
}
/**
* Delegate processing of the tree node to {@link Tree#processTreeNode(FacesContext, PhaseId)}.
* @see Tree#processTreeNode(FacesContext, PhaseId)
*/
@Override
protected void process(FacesContext context, PhaseId phaseId) {
getClosestParent(this, Tree.class).processTreeNode(context, phaseId);
}
/**
* Delegate visiting of the tree node to {@link Tree#visitTreeNode(VisitContext, VisitCallback)}.
* @see Tree#visitTreeNode(VisitContext, VisitCallback)
*/
@Override
public boolean visitTree(VisitContext context, VisitCallback callback) {
if (context.getHints().contains(SKIP_ITERATION)) {
return super.visitTree(context, callback);
}
return getClosestParent(this, Tree.class).visitTreeNode(context, callback);
}
}