Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.ui.tapestry.components.panel
Class SearchPanel

java.lang.Object
  extended by org.apache.hivemind.impl.BaseLocatable
      extended by org.apache.tapestry.AbstractComponent
          extended by org.apache.tapestry.BaseComponent
              extended by org.hyperic.ui.tapestry.components.panel.SearchPanel
All Implemented Interfaces:
org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, org.apache.tapestry.IComponent, org.apache.tapestry.IDirectEvent, org.apache.tapestry.internal.Component, org.apache.tapestry.IRender, org.apache.tapestry.ITemplateComponent

public abstract class SearchPanel
extends org.apache.tapestry.BaseComponent


Field Summary
 
Fields inherited from class org.apache.tapestry.AbstractComponent
_body, _bodyCount
 
Constructor Summary
SearchPanel()
           
 
Method Summary
abstract  boolean getEnableHotkeys()
          Should the enter, escape and ctrl-s keystrokes be captured for this component
abstract  java.lang.String getHotkey()
          The JSON object that specifies
abstract  org.apache.tapestry.IScript getScript()
           
abstract  org.apache.tapestry.engine.IEngineService getSearchService()
           
 java.lang.String getSearchServiceURL()
          Get the URL for the search service Used for SearchPanel.script for the search XHR
 void renderComponent(org.apache.tapestry.IMarkupWriter writer, org.apache.tapestry.IRequestCycle cycle)
           
abstract  void setEnableHotkeys(boolean enable)
           
abstract  void setHotkey(java.lang.String hotKey)
           
 
Methods inherited from class org.apache.tapestry.BaseComponent
addOuter, finishLoad, getContainedRenderers, getInnerRenderers
 
Methods inherited from class org.apache.tapestry.AbstractComponent
addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, enterActiveState, equals, finishLoad, generateClientId, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getBoundId, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getRenderWorker, getSpecification, getSpecifiedId, getTemplateTagName, hasEvents, hashCode, isInActiveState, isParameterBound, isRendering, isStateful, pageEndRender, peekClientId, prepareForRender, render, renderBody, renderIdAttribute, renderInformalParameters, setBinding, setClientId, setContainedComponent, setContainer, setHasEvents, setId, setNamespace, setPage, setTemplateTagName, toString, triggerEvent
 
Methods inherited from class org.apache.hivemind.impl.BaseLocatable
getLocation, setLocation
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.tapestry.IComponent
addAsset, addBody, addComponent, enterActiveState, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getSpecification, getSpecifiedId, getTemplateTagName, isRendering, peekClientId, renderBody, setBinding, setClientId, setContainedComponent, setContainer, setId, setNamespace, setPage, setTemplateTagName
 
Methods inherited from interface org.apache.tapestry.IRender
render
 
Methods inherited from interface org.apache.hivemind.LocationHolder
setLocation
 
Methods inherited from interface org.apache.hivemind.Locatable
getLocation
 

Constructor Detail

SearchPanel

public SearchPanel()
Method Detail

getEnableHotkeys

@Parameter(name="enableHotkeys",
           defaultValue="ognl:true")
public abstract boolean getEnableHotkeys()
Should the enter, escape and ctrl-s keystrokes be captured for this component

Returns:
are hotkeys enabled

setEnableHotkeys

public abstract void setEnableHotkeys(boolean enable)

getHotkey

@Parameter(name="hotKey",
           defaultValue="literal: {keyCode: 83, ctrl: true, alt: true}")
public abstract java.lang.String getHotkey()
The JSON object that specifies

Returns:
the hotkey combination

setHotkey

public abstract void setHotkey(java.lang.String hotKey)

getScript

@InjectScript(value="SearchPanel.script")
public abstract org.apache.tapestry.IScript getScript()

getSearchService

@InjectObject(value="infrastructure:searchService")
public abstract org.apache.tapestry.engine.IEngineService getSearchService()

getSearchServiceURL

public java.lang.String getSearchServiceURL()
Get the URL for the search service Used for SearchPanel.script for the search XHR

Returns:
the URL.toString()

renderComponent

public void renderComponent(org.apache.tapestry.IMarkupWriter writer,
                            org.apache.tapestry.IRequestCycle cycle)
Overrides:
renderComponent in class org.apache.tapestry.BaseComponent

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.