|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use Component | |
|---|---|
| org.zkoss.zk.au | Commands used to communicate between client and server, called asynchronous updates. |
| org.zkoss.zk.el | EL Evaluator Relevant Classes |
| org.zkoss.zk.fn | A collections of functions used in EL expressions (implementation only). |
| org.zkoss.zk.scripting | Scripting intepreter relevant classes, including interpreter, namespace and so on. |
| org.zkoss.zk.ui | Interfaces of the common user-interfaces, such as Page and Component. |
| org.zkoss.zk.ui.event | The org.zkoss.zk.ui and org.zkoss.zk.ui.event packages are the only packages that component and application developers need to know. |
| org.zkoss.zk.ui.ext.render | Additional Interfaces that might be implemented by the returned object of getExtraCtrl(). |
| org.zkoss.zk.ui.impl | Implementation of user interfaces and factories (implementation only). |
| org.zkoss.zk.ui.metainfo | Metainfo representing pages and languages (implementation only). |
| org.zkoss.zk.ui.metainfo.impl | The implementation class of the metainfos. |
| org.zkoss.zk.ui.sys | Internal interfaces of user interfaces and factories (behind the scene). |
| org.zkoss.zk.ui.util | Utilities to handle user interfaces. |
| Uses of Component in org.zkoss.zk.au |
|---|
| Methods in org.zkoss.zk.au that return Component | |
|---|---|
Component |
AuRequest.getComponent()
Returns the component that this request is applied for, or null if it applies to the whole page or a general request. |
| Constructors in org.zkoss.zk.au with parameters of type Component | |
|---|---|
AuAppendChild(Component comp,
java.lang.String content)
|
|
AuCloseErrorBox(Component comp)
|
|
AuCmd(Component comp,
java.lang.String function)
Construct AuCmd to call a client function with one argument, the component itself. |
|
AuCmd(Component comp,
java.lang.String function,
java.lang.String arg)
Construct AuCmd to call a client function with two arguments, the component itself and arg. |
|
AuCmd(Component comp,
java.lang.String function,
java.lang.String arg1,
java.lang.String arg2)
Construct AuCmd to call a client function with three arguments, the component itself, arg1 and arg2. |
|
AuCmd(Component comp,
java.lang.String function,
java.lang.String arg1,
java.lang.String arg2,
java.lang.String arg3)
Construct AuCmd to call a client function with four arguments, the component itself, arg1, arg2 and arg3. |
|
AuFocus(Component comp)
|
|
AuInsertAfter(Component comp,
java.lang.String content)
|
|
AuInsertBefore(Component comp,
java.lang.String content)
|
|
AuRemove(Component comp)
|
|
AuRemoveAttribute(Component comp,
java.lang.String attr)
|
|
AuReplace(Component comp,
java.lang.String content)
|
|
AuResponse(java.lang.String cmd,
Component depends,
java.lang.String data)
Constructs a response with one or zero data. |
|
AuResponse(java.lang.String cmd,
Component depends,
java.lang.String[] data)
Constructs a response with multiple data. |
|
AuScript(Component depends,
java.lang.String script)
|
|
AuSetAttribute(Component comp,
java.lang.String attr,
java.lang.String val)
|
|
AuWrongValue(Component comp,
java.lang.String message)
|
|
| Uses of Component in org.zkoss.zk.el |
|---|
| Methods in org.zkoss.zk.el with parameters of type Component | |
|---|---|
java.lang.Object |
Evaluator.evaluate(Component comp,
java.lang.String expr,
java.lang.Class expectedType)
Evaluates the specified expression against the specified component. |
| Uses of Component in org.zkoss.zk.fn |
|---|
| Methods in org.zkoss.zk.fn with parameters of type Component | |
|---|---|
static void |
ZkFns.redraw(Component comp,
java.io.Writer out)
Redraw the specified component into the specified out. |
| Uses of Component in org.zkoss.zk.scripting |
|---|
| Methods in org.zkoss.zk.scripting with parameters of type Component | |
|---|---|
static Namespace |
Namespaces.beforeInterpret(java.util.Map backup,
Component comp,
boolean pushNS)
Prepares builtin variable before calling Page.interpret(java.lang.String, java.lang.String, org.zkoss.zk.scripting.Namespace). |
| Uses of Component in org.zkoss.zk.ui |
|---|
| Classes in org.zkoss.zk.ui that implement Component | |
|---|---|
class |
AbstractComponent
A skeletal implementation of Component. |
class |
HtmlBasedComponent
A skeletal implementation for HTML based components. |
class |
HtmlMacroComponent
The implemetation of a macro component upon HTML. |
| Methods in org.zkoss.zk.ui that return Component | |
|---|---|
static Component |
Executions.createComponents(PageDefinition pagedef,
Component parent,
java.util.Map arg)
Creates components based on the specified page definition. |
Component |
Execution.createComponents(PageDefinition pagedef,
Component parent,
java.util.Map arg)
Creates components from the specified page definition. |
Component[] |
Execution.createComponents(PageDefinition pagedef,
java.util.Map arg)
Creates components that don't belong to any page from the specified page definition. |
static Component |
Executions.createComponents(java.lang.String uri,
Component parent,
java.util.Map arg)
Creates components from a page file specified by an URI. |
Component |
Execution.createComponents(java.lang.String uri,
Component parent,
java.util.Map arg)
Creates components from a page file specified by an URI. |
Component[] |
Execution.createComponents(java.lang.String uri,
java.util.Map arg)
Creates components that don't belong to any page from a page file specified by an URI. |
static Component |
Executions.createComponentsDirectly(org.zkoss.idom.Document content,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content specified by a DOM tree. |
Component |
Execution.createComponentsDirectly(org.zkoss.idom.Document content,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content specified by a DOM tree. |
Component[] |
Execution.createComponentsDirectly(org.zkoss.idom.Document content,
java.lang.String extension,
java.util.Map arg)
Creates components that don't belong to any page from the raw content specified by a DOM tree. |
static Component |
Executions.createComponentsDirectly(java.io.Reader reader,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content read from the specified reader. |
Component |
Execution.createComponentsDirectly(java.io.Reader reader,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content read from the specified reader. |
Component[] |
Execution.createComponentsDirectly(java.io.Reader reader,
java.lang.String extension,
java.util.Map arg)
Creates components that don't belong to any page from the raw content read from the specified reader. |
static Component |
Executions.createComponentsDirectly(java.lang.String content,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content specified by a string. |
Component |
Execution.createComponentsDirectly(java.lang.String content,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content specified by a string. |
Component[] |
Execution.createComponentsDirectly(java.lang.String content,
java.lang.String extension,
java.util.Map arg)
Creates components that don't belong to any page from the raw content specified by a string. |
Component |
WrongValueException.getComponent()
Returns the component that causes this exception, or null. |
Component |
Path.getComponent()
Returns the component with this path. |
static Component |
Path.getComponent(IdSpace is,
java.lang.String path)
Returns the component of the specified path which is related to the specified ID space. |
static Component |
Path.getComponent(java.lang.String path)
Returns the component of the specified path. |
Component |
Desktop.getComponentByUuid(java.lang.String uuid)
Returns the component of the specified UUID ( getUuid()). |
Component |
Desktop.getComponentByUuidIfAny(java.lang.String uuid)
Returns the component of the specified UUID ( getUuid()), or null if not found. |
Component |
IdSpace.getFellow(java.lang.String id)
Returns a component of the specified ID in the same ID space. |
Component |
Component.getFellow(java.lang.String id)
Returns a component of the specified ID in the same ID space. |
Component |
AbstractComponent.getFellow(java.lang.String compId)
|
Component |
IdSpace.getFellowIfAny(java.lang.String id)
Returns a component of the specified ID in the same ID space, or null if not found. |
Component |
Component.getFellowIfAny(java.lang.String id)
Returns a component of the specified ID in the same ID space, or null if not found. |
Component |
AbstractComponent.getFellowIfAny(java.lang.String compId)
|
Component |
Component.getParent()
Returns the parent component, or null if this is the root component. |
Component |
AbstractComponent.getParent()
|
Component |
AbstractComponent.getPropagatee(java.lang.String evtnm)
Default: null (no propagation at all). |
Component |
Component.getRoot()
Returns the root of this component. |
Component |
AbstractComponent.getRoot()
Returns the root of the specified component. |
| Methods in org.zkoss.zk.ui with parameters of type Component | |
|---|---|
boolean |
Component.appendChild(Component child)
Appends a child. |
boolean |
AbstractComponent.appendChild(Component child)
Appends a child to the end of all children. |
static Component |
Executions.createComponents(PageDefinition pagedef,
Component parent,
java.util.Map arg)
Creates components based on the specified page definition. |
Component |
Execution.createComponents(PageDefinition pagedef,
Component parent,
java.util.Map arg)
Creates components from the specified page definition. |
static Component |
Executions.createComponents(java.lang.String uri,
Component parent,
java.util.Map arg)
Creates components from a page file specified by an URI. |
Component |
Execution.createComponents(java.lang.String uri,
Component parent,
java.util.Map arg)
Creates components from a page file specified by an URI. |
static Component |
Executions.createComponentsDirectly(org.zkoss.idom.Document content,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content specified by a DOM tree. |
Component |
Execution.createComponentsDirectly(org.zkoss.idom.Document content,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content specified by a DOM tree. |
static Component |
Executions.createComponentsDirectly(java.io.Reader reader,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content read from the specified reader. |
Component |
Execution.createComponentsDirectly(java.io.Reader reader,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content read from the specified reader. |
static Component |
Executions.createComponentsDirectly(java.lang.String content,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content specified by a string. |
Component |
Execution.createComponentsDirectly(java.lang.String content,
java.lang.String extension,
Component parent,
java.util.Map arg)
Creates components from the raw content specified by a string. |
static java.lang.Object |
Executions.evaluate(Component comp,
java.lang.String expr,
java.lang.Class expectedType)
Evluates the specified expression by use of the current context ( Executions.getCurrent()). |
java.lang.Object |
Execution.evaluate(Component comp,
java.lang.String expr,
java.lang.Class expectedType)
Evluates the specified expression with ${link #getVariableResolver} and Page.getFunctionMapper() of the page of the specified
component. |
java.lang.String |
Desktop.getDynamicMediaURI(Component comp,
java.lang.String pathInfo)
Returns URI for a dynamic generated media associated with a component. |
static java.lang.String |
Path.getPath(Component comp)
Returns the path of the specified component. |
static java.util.Collection |
Components.getVisibleChildren(Component comp)
Returns a collection of visible children. |
boolean |
Component.insertBefore(Component newChild,
Component refChild)
Inserts a child before the reference child. |
boolean |
AbstractComponent.insertBefore(Component newChild,
Component refChild)
|
static boolean |
Components.isAncestor(Component node1,
Component node2)
Tests whether node1 is an ancessor of node 2. |
static boolean |
Components.isRealVisible(Component comp)
Returns whether this component is real visible (all its parents are visible). |
void |
Component.onChildAdded(Component child)
Called when a child is added. |
void |
AbstractComponent.onChildAdded(Component child)
Default: does nothing. |
void |
Component.onChildRemoved(Component child)
Called when a child is removed. |
void |
AbstractComponent.onChildRemoved(Component child)
Default: does nothing. |
void |
Component.onDrawNewChild(Component child,
java.lang.StringBuffer out)
Called when a new-created child is drawn. |
void |
AbstractComponent.onDrawNewChild(Component child,
java.lang.StringBuffer out)
|
static void |
Components.removeAllChildren(Component comp)
Removes all children of the specified component. |
boolean |
Component.removeChild(Component child)
Removes a child. |
boolean |
AbstractComponent.removeChild(Component child)
|
void |
HtmlMacroComponent.setParent(Component parent)
Changes the parent. |
void |
Component.setParent(Component parent)
Sets the parent component. |
void |
AbstractComponent.setParent(Component parent)
|
| Constructors in org.zkoss.zk.ui with parameters of type Component | |
|---|---|
Path(Component comp)
Returns the path of the specified component. |
|
WrongValueException(Component comp,
int code)
Contructs a wrong value exception to show an error box at the client. |
|
WrongValueException(Component comp,
int code,
java.lang.Object fmtArg)
Contructs a wrong value exception to show an error box at the client. |
|
WrongValueException(Component comp,
int code,
java.lang.Object[] fmtArgs)
Contructs a wrong value exception to show an error box at the client. |
|
WrongValueException(Component comp,
java.lang.String msg)
Contructs a wrong value exception to show an error box at the client. |
|
| Uses of Component in org.zkoss.zk.ui.event |
|---|
| Methods in org.zkoss.zk.ui.event that return Component | |
|---|---|
Component |
DropEvent.getDragged()
Returns the component being dragged and drop to Event.getTarget(). |
Component |
OpenEvent.getReference()
Returns the reference that is the component causing Event.getTarget()
to be opened. |
Component |
Event.getTarget()
Returns the target component that receives this event, or null if broadcast. |
| Methods in org.zkoss.zk.ui.event with parameters of type Component | |
|---|---|
void |
EventThreadResume.abortResume(Component comp,
Event evt)
Called when the suspended event thread is aborted. |
void |
EventThreadResume.afterResume(Component comp,
Event evt)
Called after the suspended event thread is resumed. |
void |
EventThreadSuspend.afterSuspend(Component comp,
Event evt)
Called in the servlet thread after the event processing thread has been suspended. |
void |
EventThreadResume.beforeResume(Component comp,
Event evt)
Called just before the suspended event thread is resumed. |
void |
EventThreadSuspend.beforeSuspend(Component comp,
Event evt,
java.lang.Object obj)
Called before the event processing thread is suspended. |
void |
EventThreadCleanup.cleanup(Component comp,
Event evt,
java.util.List errs)
Cleans up the event processing thread. |
void |
EventThreadCleanup.complete(Component comp,
Event evt)
Called in the serlvet thread to clean up. |
void |
EventThreadInit.init(Component comp,
Event evt)
Initialize the event processing thread before processing the event. |
static boolean |
Events.isListened(Component comp,
java.lang.String evtnm,
boolean asap)
Returns whether an event handler or listener is available for the specified component and event. |
static boolean |
Events.isListenerAvailable(Component comp,
java.lang.String evtnm,
boolean asap)
Deprecated. |
static void |
Events.postEvent(java.lang.String name,
Component target,
java.lang.Object data)
Posts a generic event (aka, an instance of Event). |
void |
EventThreadInit.prepare(Component comp,
Event evt)
Prepares the initialization at the servlet thread. |
static void |
Events.sendEvent(Component comp,
Event event)
Sends the event to the specified component and process it immediately. |
| Constructors in org.zkoss.zk.ui.event with parameters of type Component | |
|---|---|
CheckEvent(java.lang.String name,
Component target,
boolean checked)
Constructs a check-relevant event. |
|
CreateEvent(java.lang.String name,
Component target,
java.util.Map args)
|
|
DropEvent(java.lang.String name,
Component target,
Component dragged,
int x,
int y,
int keys)
Constructs a drop event. |
|
ErrorEvent(java.lang.String name,
Component target,
java.lang.String val,
java.lang.String msg)
Constructs an error-relevant event. |
|
Event(java.lang.String name,
Component target)
Constructs a simple event. |
|
Event(java.lang.String name,
Component target,
java.lang.Object data)
Constructs a simple event. |
|
InputEvent(java.lang.String name,
Component target,
java.lang.String val)
Constructs a input-relevant event. |
|
InputEvent(java.lang.String name,
Component target,
java.lang.String val,
boolean selbk)
Constructs an event for onChanging. |
|
KeyEvent(java.lang.String name,
Component target,
int keyCode,
boolean ctrlKey,
boolean shiftKey,
boolean altKey)
Constructs a mouse relevant event. |
|
MouseEvent(java.lang.String name,
Component target)
Construct a mouse relevant event with coordination or area. |
|
MouseEvent(java.lang.String name,
Component target,
int x,
int y)
Constructs a mouse relevant event. |
|
MouseEvent(java.lang.String name,
Component target,
int x,
int y,
int keys)
Constructs a mouse relevant event. |
|
MouseEvent(java.lang.String name,
Component target,
java.lang.String area)
Constructs a mouse relevant event with a logic name called area. |
|
MoveEvent(java.lang.String name,
Component target,
java.lang.String left,
java.lang.String top,
int keys)
Constructs a mouse relevant event. |
|
OpenEvent(java.lang.String name,
Component target,
boolean open)
Constructs an onOpen event. |
|
OpenEvent(java.lang.String name,
Component target,
boolean open,
Component ref)
Constructs an onOpen event for a context menu, a tooltip or a popup. |
|
ScrollEvent(java.lang.String name,
Component target,
int pos)
Constructs an scroll-relevant event. |
|
SelectEvent(java.lang.String name,
Component target,
java.util.Set selectedItems)
Constructs a selection event. |
|
SelectionEvent(java.lang.String name,
Component target,
int start,
int end,
java.lang.String txt)
Constructs a selection event. |
|
SizeEvent(java.lang.String name,
Component target,
java.lang.String width,
java.lang.String height,
int keys)
Constructs a mouse relevant event. |
|
UploadEvent(java.lang.String name,
Component target,
org.zkoss.util.media.Media[] meds)
Constructs the upload event. |
|
ZIndexEvent(java.lang.String name,
Component target,
int zIndex)
Constructs a mouse relevant event. |
|
| Uses of Component in org.zkoss.zk.ui.ext.render |
|---|
| Methods in org.zkoss.zk.ui.ext.render with parameters of type Component | |
|---|---|
boolean |
MultiBranch.inDifferentBranch(Component child)
Whether the specified child is placed in different branch of the DOM tree (other than the main one). |
| Uses of Component in org.zkoss.zk.ui.impl |
|---|
| Methods in org.zkoss.zk.ui.impl that return Component | |
|---|---|
Component[] |
UiEngineImpl.createComponents(Execution exec,
PageDefinition pagedef,
Page page,
Component parent,
java.util.Map arg)
|
Component |
AbstractExecution.createComponents(PageDefinition pagedef,
Component parent,
java.util.Map arg)
|
Component[] |
AbstractExecution.createComponents(PageDefinition pagedef,
java.util.Map arg)
|
Component |
AbstractExecution.createComponents(java.lang.String uri,
Component parent,
java.util.Map arg)
|
Component[] |
AbstractExecution.createComponents(java.lang.String uri,
java.util.Map arg)
|
Component |
AbstractExecution.createComponentsDirectly(org.zkoss.idom.Document content,
java.lang.String ext,
Component parent,
java.util.Map arg)
|
Component[] |
AbstractExecution.createComponentsDirectly(org.zkoss.idom.Document content,
java.lang.String ext,
java.util.Map arg)
|
Component |
AbstractExecution.createComponentsDirectly(java.io.Reader reader,
java.lang.String ext,
Component parent,
java.util.Map arg)
|
Component[] |
AbstractExecution.createComponentsDirectly(java.io.Reader reader,
java.lang.String ext,
java.util.Map arg)
|
Component |
AbstractExecution.createComponentsDirectly(java.lang.String content,
java.lang.String ext,
Component parent,
java.util.Map arg)
|
Component[] |
AbstractExecution.createComponentsDirectly(java.lang.String content,
java.lang.String ext,
java.util.Map arg)
|
Component |
EventProcessor.getComponent()
Returns the component. |
Component |
EventProcessingThreadImpl.getComponent()
|
Component |
DesktopImpl.getComponentByUuid(java.lang.String uuid)
|
Component |
DesktopImpl.getComponentByUuidIfAny(java.lang.String uuid)
|
Component |
PageImpl.getDefaultParent()
|
Component |
PageImpl.getFellow(java.lang.String compId)
|
Component |
PageImpl.getFellowIfAny(java.lang.String compId)
|
Component |
PageImpl.getOwner()
|
Component |
AbstractUiFactory.newComponent(Page page,
Component parent,
ComponentDefinition compdef,
java.lang.String clsnm)
|
Component |
AbstractUiFactory.newComponent(Page page,
Component parent,
ComponentInfo compInfo)
|
| Methods in org.zkoss.zk.ui.impl with parameters of type Component | |
|---|---|
void |
DesktopImpl.addComponent(Component comp)
|
void |
PageImpl.addDeferredZScript(Component parent,
ZScript zscript)
|
void |
PageImpl.addFellow(Component comp)
|
void |
UiEngineImpl.addInvalidate(Component comp)
|
void |
UiEngineImpl.addMoved(Component comp,
Component oldparent,
Page oldpg,
Page newpg)
|
void |
PageImpl.addRoot(Component comp)
|
void |
UiEngineImpl.addSmartUpdate(Component comp,
java.lang.String attr,
java.lang.String value)
|
void |
UiEngineImpl.addUuidChanged(Component comp,
boolean addOnlyMoved)
Called before changing the component's UUID. |
Component[] |
UiEngineImpl.createComponents(Execution exec,
PageDefinition pagedef,
Page page,
Component parent,
java.util.Map arg)
|
Component |
AbstractExecution.createComponents(PageDefinition pagedef,
Component parent,
java.util.Map arg)
|
Component |
AbstractExecution.createComponents(java.lang.String uri,
Component parent,
java.util.Map arg)
|
Component |
AbstractExecution.createComponentsDirectly(org.zkoss.idom.Document content,
java.lang.String ext,
Component parent,
java.util.Map arg)
|
Component |
AbstractExecution.createComponentsDirectly(java.io.Reader reader,
java.lang.String ext,
Component parent,
java.util.Map arg)
|
Component |
AbstractExecution.createComponentsDirectly(java.lang.String content,
java.lang.String ext,
Component parent,
java.util.Map arg)
|
java.lang.Object |
AbstractExecution.evaluate(Component comp,
java.lang.String expr,
java.lang.Class expectedType)
|
java.lang.String |
DesktopImpl.getDynamicMediaURI(Component comp,
java.lang.String pathInfo)
|
Component |
AbstractUiFactory.newComponent(Page page,
Component parent,
ComponentDefinition compdef,
java.lang.String clsnm)
|
Component |
AbstractUiFactory.newComponent(Page page,
Component parent,
ComponentInfo compInfo)
|
boolean |
EventProcessingThreadImpl.processEvent(Desktop desktop,
Component comp,
Event event)
Ask this event thread to process the specified event. |
void |
UiEngineImpl.pushOwner(Component comp)
|