KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > action > GroupMarker


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.jface.action;
12
13 /**
14  * A group marker is a special kind of contribution item denoting
15  * the beginning of a group. These groups are used to structure
16  * the list of items. Unlike regular contribution items and
17  * separators, group markers have no visual representation.
18  * The name of the group is synonymous with the contribution item id.
19  * <p>
20  * This class may be instantiated; it is not intended to be
21  * subclassed outside the framework.
22  * </p>
23  */
24 public class GroupMarker extends AbstractGroupMarker {
25     /**
26      * Create a new group marker with the given name.
27      * The group name must not be <code>null</code> or the empty string.
28      * The group name is also used as the item id.
29      *
30      * @param groupName the name of the group
31      */
32     public GroupMarker(String JavaDoc groupName) {
33         super(groupName);
34     }
35
36     /**
37      * The <code>GroupMarker</code> implementation of this method
38      * returns <code>false</code> since group markers are always invisible.
39      */
40     public boolean isVisible() {
41         return false;
42     }
43 }
44
Popular Tags