View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.portalsite;
18  
19  import java.util.Locale;
20  
21  /***
22   * This interface describes the portal-site menu separator
23   * elements constructed and returned to decorators.
24   * 
25   * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
26   * @version $Id: MenuSeparator.java 516448 2007-03-09 16:25:47Z ate $
27   */
28  public interface MenuSeparator extends MenuElement
29  {
30      /***
31       * getText - get default text for menu separator
32       *
33       * @return text
34       */
35      String getText();
36  
37      /***
38       * getText - get locale specific text for menu separator
39       *           from metadata
40       *
41       * @param locale preferred locale
42       * @return text
43       */
44      String getText(Locale locale);
45  }