// WARNING: This file was automatically generated. Do not edit it directly,
   //          or you will lose your changes.
   
   /*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you 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
   *
   *   http://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.apache.myfaces.trinidad.component.core.layout;
  
  import java.util.Arrays;
  import java.util.Collection;
  import java.util.Collections;
  import java.util.List;
  import java.util.Map;
  import javax.faces.component.UIComponent;
  import javax.faces.component.behavior.ClientBehavior;
  import javax.faces.component.behavior.ClientBehaviorHolder;
  import org.apache.myfaces.trinidad.bean.FacesBean;
  import org.apache.myfaces.trinidad.bean.PropertyKey;
  import org.apache.myfaces.trinidad.component.UIXPanel;
  import org.apache.myfaces.trinidad.util.ComponentUtils;
  
  /**
   *
   * PanelPageHeader lays out the top portion of a page.
   *
   * <h4>Events:</h4>
   * <table border="1" width="100%" cellpadding="3" summary="">
   * <tr bgcolor="#CCCCFF" class="TableHeadingColor">
   * <th align="left">Type</th>
   * <th align="left">Phases</th>
   * <th align="left">Description</th>
   * </tr>
   * <tr class="TableRowColor">
   * <td valign="top"><code>org.apache.myfaces.trinidad.event.AttributeChangeEvent</code></td>
   * <td valign="top" nowrap>Invoke<br>Application<br>Apply<br>Request<br>Values</td>
   * <td valign="top">Event delivered to describe an attribute change.  Attribute change events are not delivered for any programmatic change to a property.  They are only delivered when a renderer changes a property without the application's specific request.  An example of an attribute change event might include the width of a column that supported client-side resizing.</td>
   * </tr>
   * </table>
   */
  public class CorePanelPageHeader extends UIXPanel
                                   implements ClientBehaviorHolder
  {
    static public final String CHROME_TYPE_COMPACT = "compact";
    static public final String CHROME_TYPE_EXPANDED = "expanded";
    static public final FacesBean.Type TYPE = new FacesBean.Type(
      UIXPanel.TYPE);
    static public final PropertyKey CHROME_TYPE_KEY =
      TYPE.registerKey("chromeType", String.class, "compact");
    static public final PropertyKey INLINE_STYLE_KEY =
      TYPE.registerKey("inlineStyle", String.class);
    static public final PropertyKey STYLE_CLASS_KEY =
      TYPE.registerKey("styleClass", String.class);
    static public final PropertyKey SHORT_DESC_KEY =
      TYPE.registerKey("shortDesc", String.class);
    static public final PropertyKey PARTIAL_TRIGGERS_KEY =
      TYPE.registerKey("partialTriggers", String[].class, null, 0, PropertyKey.Mutable.RARELY);
    static public final PropertyKey ONCLICK_KEY =
      TYPE.registerKey("onclick", String.class);
    static public final PropertyKey ONDBLCLICK_KEY =
      TYPE.registerKey("ondblclick", String.class);
    static public final PropertyKey ONMOUSEDOWN_KEY =
      TYPE.registerKey("onmousedown", String.class);
    static public final PropertyKey ONMOUSEUP_KEY =
      TYPE.registerKey("onmouseup", String.class);
    static public final PropertyKey ONMOUSEOVER_KEY =
      TYPE.registerKey("onmouseover", String.class);
    static public final PropertyKey ONMOUSEMOVE_KEY =
      TYPE.registerKey("onmousemove", String.class);
    static public final PropertyKey ONMOUSEOUT_KEY =
      TYPE.registerKey("onmouseout", String.class);
    static public final PropertyKey ONKEYPRESS_KEY =
      TYPE.registerKey("onkeypress", String.class);
    static public final PropertyKey ONKEYDOWN_KEY =
      TYPE.registerKey("onkeydown", String.class);
    static public final PropertyKey ONKEYUP_KEY =
      TYPE.registerKey("onkeyup", String.class);
    static public final String NAVIGATION1_FACET = "navigation1";
    static public final String NAVIGATION2_FACET = "navigation2";
    static public final String NAVIGATION_GLOBAL_FACET = "navigationGlobal";
    static public final String MENU_SWITCH_FACET = "menuSwitch";
    static public final String BRANDING_FACET = "branding";
    static public final String BRANDING_APP_FACET = "brandingApp";
    static public final String BRANDING_APP_CONTEXTUAL_FACET = "brandingAppContextual";
    static public final String SEARCH_FACET = "search";
 
   static public final String COMPONENT_FAMILY =
     "org.apache.myfaces.trinidad.Panel";
   static public final String COMPONENT_TYPE =
     "org.apache.myfaces.trinidad.CorePanelPageHeader";
   // Supported client events for client behaviors:
   private final static Collection<String> _EVENT_NAMES = Collections.unmodifiableCollection(
     Arrays.asList(
       "click", "dblclick", "mousedown", "mouseup", "mouseover", "mousemove",
       "mouseout", "keypress", "keydown", "keyup"
     ));
 
   /**
    * Construct an instance of the CorePanelPageHeader.
    */
   public CorePanelPageHeader()
   {
     super("org.apache.myfaces.trinidad.PageHeader");
   }
 
   /**
    * This location typically contains a menuTabs.
    */
   final public UIComponent getNavigation1()
   {
     return getFacet(NAVIGATION1_FACET);
   }
 
   /**
    * This location typically contains a menuTabs.
    */
   @SuppressWarnings("unchecked")
   final public void setNavigation1(UIComponent navigation1Facet)
   {
     getFacets().put(NAVIGATION1_FACET, navigation1Facet);
   }
 
   /**
    * This location typically contains a menuBar.
    */
   final public UIComponent getNavigation2()
   {
     return getFacet(NAVIGATION2_FACET);
   }
 
   /**
    * This location typically contains a menuBar.
    */
   @SuppressWarnings("unchecked")
   final public void setNavigation2(UIComponent navigation2Facet)
   {
     getFacets().put(NAVIGATION2_FACET, navigation2Facet);
   }
 
   /**
    * This section typically contains a menuButtons.
    */
   final public UIComponent getNavigationGlobal()
   {
     return getFacet(NAVIGATION_GLOBAL_FACET);
   }
 
   /**
    * This section typically contains a menuButtons.
    */
   @SuppressWarnings("unchecked")
   final public void setNavigationGlobal(UIComponent navigationGlobalFacet)
   {
     getFacets().put(NAVIGATION_GLOBAL_FACET, navigationGlobalFacet);
   }
 
   /**
    * This location typically contains a menuChoice.
    */
   final public UIComponent getMenuSwitch()
   {
     return getFacet(MENU_SWITCH_FACET);
   }
 
   /**
    * This location typically contains a menuChoice.
    */
   @SuppressWarnings("unchecked")
   final public void setMenuSwitch(UIComponent menuSwitchFacet)
   {
     getFacets().put(MENU_SWITCH_FACET, menuSwitchFacet);
   }
 
   /**
    * The corporate or organization branding region of the page.  This section typically
    *                 contains a medium size image of the logo of the organization
    *                 owning the page.
    */
   final public UIComponent getBranding()
   {
     return getFacet(BRANDING_FACET);
   }
 
   /**
    * The corporate or organization branding region of the page.  This section typically
    *                 contains a medium size image of the logo of the organization
    *                 owning the page.
    */
   @SuppressWarnings("unchecked")
   final public void setBranding(UIComponent brandingFacet)
   {
     getFacets().put(BRANDING_FACET, brandingFacet);
   }
 
   /**
    * The application, module, or product branding region of the page.
    *                 This section typically contains a image of the application logo.
    */
   final public UIComponent getBrandingApp()
   {
     return getFacet(BRANDING_APP_FACET);
   }
 
   /**
    * The application, module, or product branding region of the page.
    *                 This section typically contains a image of the application logo.
    */
   @SuppressWarnings("unchecked")
   final public void setBrandingApp(UIComponent brandingAppFacet)
   {
     getFacets().put(BRANDING_APP_FACET, brandingAppFacet);
   }
 
   /**
    * The application's contextual branding region of the page.  This section typically
    *                 contains formatted text indicating that ONE context exists
    *                 between the persistent tabs. The user selects the context
    *                 from a centralized aggregate home page of multiple contexts,
    *                 then navigates into a tabbed application pertaining to that
    *                 specific context.
    */
   final public UIComponent getBrandingAppContextual()
   {
     return getFacet(BRANDING_APP_CONTEXTUAL_FACET);
   }
 
   /**
    * The application's contextual branding region of the page.  This section typically
    *                 contains formatted text indicating that ONE context exists
    *                 between the persistent tabs. The user selects the context
    *                 from a centralized aggregate home page of multiple contexts,
    *                 then navigates into a tabbed application pertaining to that
    *                 specific context.
    */
   @SuppressWarnings("unchecked")
   final public void setBrandingAppContextual(UIComponent brandingAppContextualFacet)
   {
     getFacets().put(BRANDING_APP_CONTEXTUAL_FACET, brandingAppContextualFacet);
   }
 
   /**
    * The search region of the page.
    */
   final public UIComponent getSearch()
   {
     return getFacet(SEARCH_FACET);
   }
 
   /**
    * The search region of the page.
    */
   @SuppressWarnings("unchecked")
   final public void setSearch(UIComponent searchFacet)
   {
     getFacets().put(SEARCH_FACET, searchFacet);
   }
 
   /**
    * Gets what the chromeType is for the page: compact or expanded. If
    *               compact, the productBranding will be shown alongside the
    *               corporate branding instead of below the corporate branding.
    *
    * @return  the new chromeType value
    */
   final public String getChromeType()
   {
     return ComponentUtils.resolveString(getProperty(CHROME_TYPE_KEY), "compact");
   }
 
   /**
    * Sets what the chromeType is for the page: compact or expanded. If
    *               compact, the productBranding will be shown alongside the
    *               corporate branding instead of below the corporate branding.
    * 
    * @param chromeType  the new chromeType value
    */
   final public void setChromeType(String chromeType)
   {
     setProperty(CHROME_TYPE_KEY, (chromeType));
   }
 
   /**
    * Gets the CSS styles to use for this component.
    *
    * @return  the new inlineStyle value
    */
   final public String getInlineStyle()
   {
     return ComponentUtils.resolveString(getProperty(INLINE_STYLE_KEY));
   }
 
   /**
    * Sets the CSS styles to use for this component.
    * 
    * @param inlineStyle  the new inlineStyle value
    */
   final public void setInlineStyle(String inlineStyle)
   {
     setProperty(INLINE_STYLE_KEY, (inlineStyle));
   }
 
   /**
    * Gets a CSS style class to use for this component.
    *
    * @return  the new styleClass value
    */
   final public String getStyleClass()
   {
     return ComponentUtils.resolveString(getProperty(STYLE_CLASS_KEY));
   }
 
   /**
    * Sets a CSS style class to use for this component.
    * 
    * @param styleClass  the new styleClass value
    */
   final public void setStyleClass(String styleClass)
   {
     setProperty(STYLE_CLASS_KEY, (styleClass));
   }
 
   /**
    * Gets The short description of the component. This text is commonly used by user agents to display tooltip help text.
    *
    * @return  the new shortDesc value
    */
   final public String getShortDesc()
   {
     return ComponentUtils.resolveString(getProperty(SHORT_DESC_KEY));
   }
 
   /**
    * Sets The short description of the component. This text is commonly used by user agents to display tooltip help text.
    * 
    * @param shortDesc  the new shortDesc value
    */
   final public void setShortDesc(String shortDesc)
   {
     setProperty(SHORT_DESC_KEY, (shortDesc));
   }
 
   /**
    * Gets the IDs of the components that should trigger a partial update.
    *         <p>
    *         This component will listen on the trigger components. If one of the
    *         trigger components receives an event that will cause it to update
    *         in some way, this component will request to be updated too.</p>
    *         <p>
    *         Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
    *         </p>
    *         <p>
    *         Identifiers must account for NamingContainers.  You can use a single colon to start the search from the root,
    *         or use multiple colons to move up through the NamingContainer. For example,
    *         "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), 
    *         ":::" will pop out of two naming containers, etc. The search for
    *         the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the 
    *         component with id = commandButton1 after popping out of two naming containers relative to this component.
    *         To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
    *
    * @return  the new partialTriggers value
    */
   final public String[] getPartialTriggers()
   {
     return (String[])getProperty(PARTIAL_TRIGGERS_KEY);
   }
 
   /**
    * Sets the IDs of the components that should trigger a partial update.
    *         <p>
    *         This component will listen on the trigger components. If one of the
    *         trigger components receives an event that will cause it to update
    *         in some way, this component will request to be updated too.</p>
    *         <p>
    *         Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
    *         </p>
    *         <p>
    *         Identifiers must account for NamingContainers.  You can use a single colon to start the search from the root,
    *         or use multiple colons to move up through the NamingContainer. For example,
    *         "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), 
    *         ":::" will pop out of two naming containers, etc. The search for
    *         the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the 
    *         component with id = commandButton1 after popping out of two naming containers relative to this component.
    *         To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".</p>
    * 
    * @param partialTriggers  the new partialTriggers value
    */
   final public void setPartialTriggers(String[] partialTriggers)
   {
     setProperty(PARTIAL_TRIGGERS_KEY, (partialTriggers));
   }
 
   /**
    * Gets an onclick Javascript handler.
    *
    * @return  the new onclick value
    */
   final public String getOnclick()
   {
     return ComponentUtils.resolveString(getProperty(ONCLICK_KEY));
   }
 
   /**
    * Sets an onclick Javascript handler.
    * 
    * @param onclick  the new onclick value
    */
   final public void setOnclick(String onclick)
   {
     setProperty(ONCLICK_KEY, (onclick));
   }
 
   /**
    * Gets an ondblclick Javascript handler.
    *
    * @return  the new ondblclick value
    */
   final public String getOndblclick()
   {
     return ComponentUtils.resolveString(getProperty(ONDBLCLICK_KEY));
   }
 
   /**
    * Sets an ondblclick Javascript handler.
    * 
    * @param ondblclick  the new ondblclick value
    */
   final public void setOndblclick(String ondblclick)
   {
     setProperty(ONDBLCLICK_KEY, (ondblclick));
   }
 
   /**
    * Gets an onmousedown Javascript handler.
    *
    * @return  the new onmousedown value
    */
   final public String getOnmousedown()
   {
     return ComponentUtils.resolveString(getProperty(ONMOUSEDOWN_KEY));
   }
 
   /**
    * Sets an onmousedown Javascript handler.
    * 
    * @param onmousedown  the new onmousedown value
    */
   final public void setOnmousedown(String onmousedown)
   {
     setProperty(ONMOUSEDOWN_KEY, (onmousedown));
   }
 
   /**
    * Gets an onmouseup Javascript handler.
    *
    * @return  the new onmouseup value
    */
   final public String getOnmouseup()
   {
     return ComponentUtils.resolveString(getProperty(ONMOUSEUP_KEY));
   }
 
   /**
    * Sets an onmouseup Javascript handler.
    * 
    * @param onmouseup  the new onmouseup value
    */
   final public void setOnmouseup(String onmouseup)
   {
     setProperty(ONMOUSEUP_KEY, (onmouseup));
   }
 
   /**
    * Gets an onmouseover Javascript handler.
    *
    * @return  the new onmouseover value
    */
   final public String getOnmouseover()
   {
     return ComponentUtils.resolveString(getProperty(ONMOUSEOVER_KEY));
   }
 
   /**
    * Sets an onmouseover Javascript handler.
    * 
    * @param onmouseover  the new onmouseover value
    */
   final public void setOnmouseover(String onmouseover)
   {
     setProperty(ONMOUSEOVER_KEY, (onmouseover));
   }
 
   /**
    * Gets an onmousemove Javascript handler.
    *
    * @return  the new onmousemove value
    */
   final public String getOnmousemove()
   {
     return ComponentUtils.resolveString(getProperty(ONMOUSEMOVE_KEY));
   }
 
   /**
    * Sets an onmousemove Javascript handler.
    * 
    * @param onmousemove  the new onmousemove value
    */
   final public void setOnmousemove(String onmousemove)
   {
     setProperty(ONMOUSEMOVE_KEY, (onmousemove));
   }
 
   /**
    * Gets an onmouseout Javascript handler.
    *
    * @return  the new onmouseout value
    */
   final public String getOnmouseout()
   {
     return ComponentUtils.resolveString(getProperty(ONMOUSEOUT_KEY));
   }
 
   /**
    * Sets an onmouseout Javascript handler.
    * 
    * @param onmouseout  the new onmouseout value
    */
   final public void setOnmouseout(String onmouseout)
   {
     setProperty(ONMOUSEOUT_KEY, (onmouseout));
   }
 
   /**
    * Gets an onkeypress Javascript handler.
    *
    * @return  the new onkeypress value
    */
   final public String getOnkeypress()
   {
     return ComponentUtils.resolveString(getProperty(ONKEYPRESS_KEY));
   }
 
   /**
    * Sets an onkeypress Javascript handler.
    * 
    * @param onkeypress  the new onkeypress value
    */
   final public void setOnkeypress(String onkeypress)
   {
     setProperty(ONKEYPRESS_KEY, (onkeypress));
   }
 
   /**
    * Gets an onkeydown Javascript handler.
    *
    * @return  the new onkeydown value
    */
   final public String getOnkeydown()
   {
     return ComponentUtils.resolveString(getProperty(ONKEYDOWN_KEY));
   }
 
   /**
    * Sets an onkeydown Javascript handler.
    * 
    * @param onkeydown  the new onkeydown value
    */
   final public void setOnkeydown(String onkeydown)
   {
     setProperty(ONKEYDOWN_KEY, (onkeydown));
   }
 
   /**
    * Gets an onkeyup Javascript handler.
    *
    * @return  the new onkeyup value
    */
   final public String getOnkeyup()
   {
     return ComponentUtils.resolveString(getProperty(ONKEYUP_KEY));
   }
 
   /**
    * Sets an onkeyup Javascript handler.
    * 
    * @param onkeyup  the new onkeyup value
    */
   final public void setOnkeyup(String onkeyup)
   {
     setProperty(ONKEYUP_KEY, (onkeyup));
   }
 
   @Override
   public String getDefaultEventName()
   {
     return "click";
   }
 
   @Override
   public Collection<String> getEventNames()
   {
     return _EVENT_NAMES;
   }
 
   @Override
   public Map<String, List<ClientBehavior>> getClientBehaviors()
   {
     return super.getClientBehaviors();
   }
 
   @Override
   public void addClientBehavior(
     String         eventName,
     ClientBehavior behavior)
   {
     super.addClientBehavior(eventName, behavior);
   }
 
   @Override
   public String getFamily()
   {
     return COMPONENT_FAMILY;
   }
 
   @Override
   protected FacesBean.Type getBeanType()
   {
     return TYPE;
   }
 
   /**
    * Construct an instance of the CorePanelPageHeader.
    */
   protected CorePanelPageHeader(
     String rendererType
     )
   {
     super(rendererType);
   }
 
   static
   {
     TYPE.lockAndRegister("org.apache.myfaces.trinidad.Panel","org.apache.myfaces.trinidad.PageHeader");
   }
 }