Package org.zkoss.zats.mimic.impl

Class DefaultComponentAgent

java.lang.Object

org.zkoss.zats.mimic.impl.DefaultComponentAgent

All Implemented Interfaces:

Agent, ComponentAgent, QueryAgent

public class DefaultComponentAgent
extends Object
implements ComponentAgent

The default implement of component agent. This performs operations through OperationAgentManager.

Author:

pao

Constructor Summary

Constructors

Constructor	Description
DefaultComponentAgent(PageAgent pageAgent, org.zkoss.zk.ui.Component component)

Method Summary

Modifier and Type	Method	Description
<T> T	as(Class<T> clazz)	Try to get a instance of target class for this query agent, the target class is usually a OperationAgent or a native Component if it cannot get a instance of target class, it will throw AgentException.
void	blur()	Blur this component, it is a short cut of FocusAgent.blur()
void	check(boolean checked)	Check this component, it is a short cut of CheckAgent.check(boolean)
void	click()	Click on this component, A short cut of ClickAgent.click()
void	dump()
boolean	equals(Object obj)
void	focus()	Focus this component, it is a short cut of FocusAgent.focus()
Object	getAttribute(String name)	get attribute by specify name.
ComponentAgent	getChild(int index)	get child by specify index.
List<ComponentAgent>	getChildren()	get children agents.
Client	getClient()	get client this agent belonged to.
Object	getDelegatee()	get the delegatee object
DesktopAgent	getDesktop()	get desktop agent this component belonged to.
ComponentAgent	getFirstChild()	Returns the first child, if any.
String	getId()	get ID.
ComponentAgent	getLastChild()	Returns the last child, if any.
ComponentAgent	getNextSibling()	Returns the next sibling, if any.
<T extends org.zkoss.zk.ui.Component> T	getOwner()	Returns the associated owner component of this agent
PageAgent	getPage()	get page agent this component belonged to.
ComponentAgent	getParent()	get parent agent.
ComponentAgent	getPreviousSibling()	Returns the previous sibling, if any.
String	getType()
String	getUuid()	get UUID.
int	hashCode()
void	input(Object value)	Input to this component, it is a short cut of InputAgent.input(Object)
<T> boolean	is(Class<T> clazz)	Can get a instance of target class for this query agent.
ComponentAgent	query(String selector)	to find the first component agent with the selector in this query agent.
List<ComponentAgent>	queryAll(String selector)	to find the component agents with the selector in this query agent.
void	select()	Select this component, it is a short cut of SelectAgent.select()
void	stroke(String key)	Stroke a key on this component, it is a short cut of KeyStrokeAgent.stroke(String)
String	toString()
void	type(String value)	Type on this component, it is a short cut of InputAgent.type(String)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultComponentAgent

public DefaultComponentAgent(PageAgent pageAgent,
                             org.zkoss.zk.ui.Component component)

Method Detail

getId

public String getId()

Description copied from interface: ComponentAgent

get ID. of the component.

Specified by:

getId in interface ComponentAgent

Returns:

ID or null if it hasn't.

getType

public String getType()

getAttribute

public Object getAttribute(String name)

Description copied from interface: ComponentAgent

get attribute by specify name.

Specified by:

getAttribute in interface ComponentAgent

Parameters:

name - attribute name.

Returns:

attribute value or null if not found or otherwise.

getUuid

public String getUuid()

Description copied from interface: ComponentAgent

get UUID. of the component.

Specified by:

getUuid in interface ComponentAgent

Returns:

UUID.

getChildren

public List<ComponentAgent> getChildren()

Description copied from interface: ComponentAgent

get children agents.

Specified by:

getChildren in interface ComponentAgent

Returns:

always return a list of children (may be empty).

getFirstChild

public ComponentAgent getFirstChild()

Description copied from interface: ComponentAgent

Returns the first child, if any.

Specified by:

getFirstChild in interface ComponentAgent

Returns:

the first child agent or null.

getLastChild

public ComponentAgent getLastChild()

Description copied from interface: ComponentAgent

Returns the last child, if any.

Specified by:

getLastChild in interface ComponentAgent

Returns:

the last child agent or null.

getNextSibling

public ComponentAgent getNextSibling()

Description copied from interface: ComponentAgent

Returns the next sibling, if any.

Specified by:

getNextSibling in interface ComponentAgent

Returns:

the next sibling agent or null.

getPreviousSibling

public ComponentAgent getPreviousSibling()

Description copied from interface: ComponentAgent

Returns the previous sibling, if any.

Specified by:

getPreviousSibling in interface ComponentAgent

Returns:

the previous sibling agent or null.

getChild

public ComponentAgent getChild(int index)

Description copied from interface: ComponentAgent

get child by specify index.

Specified by:

getChild in interface ComponentAgent

Returns:

child agent or null if index is out of boundary.

getParent

public ComponentAgent getParent()

Description copied from interface: ComponentAgent

get parent agent.

Specified by:

getParent in interface ComponentAgent

Returns:

parent agent or null if this is root agent.

getClient

public Client getClient()

Description copied from interface: Agent

get client this agent belonged to.

Specified by:

getClient in interface Agent

getDesktop

public DesktopAgent getDesktop()

Description copied from interface: ComponentAgent

get desktop agent this component belonged to.

Specified by:

getDesktop in interface ComponentAgent

Returns:

desktop agent.

getPage

public PageAgent getPage()

Description copied from interface: ComponentAgent

get page agent this component belonged to.

Specified by:

getPage in interface ComponentAgent

Returns:

page agent.

as

public <T> T as(Class<T> clazz)

Description copied from interface: QueryAgent

Try to get a instance of target class for this query agent, the target class is usually a OperationAgent or a native Component
if it cannot get a instance of target class, it will throw AgentException.

Specified by:

as in interface QueryAgent

Parameters:

clazz - class of specify operation.

Returns:

operation object.

is

public <T> boolean is(Class<T> clazz)

Description copied from interface: QueryAgent

Can get a instance of target class for this query agent.

Specified by:

is in interface QueryAgent

Parameters:

clazz - the class cast to.

Returns:

true if can get a instance of target class

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

query

public ComponentAgent query(String selector)

Description copied from interface: QueryAgent

to find the first component agent with the selector in this query agent.

Specified by:

query in interface QueryAgent

Parameters:

selector - the selector

Returns:

the first component agent, null if not found

queryAll

public List<ComponentAgent> queryAll(String selector)

Description copied from interface: QueryAgent

to find the component agents with the selector in this query agent.

Specified by:

queryAll in interface QueryAgent

Parameters:

selector - the selector

Returns:

the component agents

toString

public String toString()

Overrides:

toString in class Object

dump

public void dump()

getDelegatee

public Object getDelegatee()

Description copied from interface: Agent

get the delegatee object

Specified by:

getDelegatee in interface Agent

getOwner

public <T extends org.zkoss.zk.ui.Component> T getOwner()

Description copied from interface: ComponentAgent

Returns the associated owner component of this agent

Specified by:

getOwner in interface ComponentAgent

Returns:

click

public void click()

Description copied from interface: ComponentAgent

Click on this component, A short cut of ClickAgent.click()

If this component doesn't support ClickAgent, it will throw exception.

Specified by:

click in interface ComponentAgent

See Also:

QueryAgent.as(Class), ClickAgent

type

public void type(String value)

Description copied from interface: ComponentAgent

Type on this component, it is a short cut of InputAgent.type(String)

If this component doesn't support InputAgent, it will throw exception.

Specified by:

type in interface ComponentAgent

See Also:

QueryAgent.as(Class), InputAgent

input

public void input(Object value)

Description copied from interface: ComponentAgent

Input to this component, it is a short cut of InputAgent.input(Object)

If this component doesn't support InputAgent, it will throw exception.

Specified by:

input in interface ComponentAgent

See Also:

QueryAgent.as(Class), InputAgent

focus

public void focus()

Description copied from interface: ComponentAgent

Focus this component, it is a short cut of FocusAgent.focus()

If this component doesn't support FocusAgent, it will throw exception.

Specified by:

focus in interface ComponentAgent

See Also:

QueryAgent.as(Class), FocusAgent

blur

public void blur()

Description copied from interface: ComponentAgent

Blur this component, it is a short cut of FocusAgent.blur()

If this component doesn't support FocusAgent, it will throw exception.

Specified by:

blur in interface ComponentAgent

See Also:

QueryAgent.as(Class), FocusAgent

check

public void check(boolean checked)

Description copied from interface: ComponentAgent

Check this component, it is a short cut of CheckAgent.check(boolean)

If this component doesn't support CheckAgent, it will throw exception.

Specified by:

check in interface ComponentAgent

See Also:

QueryAgent.as(Class), CheckAgent

stroke

public void stroke(String key)

Description copied from interface: ComponentAgent

Stroke a key on this component, it is a short cut of KeyStrokeAgent.stroke(String)

If this component doesn't support KeyStrokeAgent, it will throw exception.

Specified by:

stroke in interface ComponentAgent

See Also:

QueryAgent.as(Class), KeyStrokeAgent

select

public void select()

Description copied from interface: ComponentAgent

Select this component, it is a short cut of SelectAgent.select()

If this component doesn't support SelectAgent, it will throw exception.

Specified by:

select in interface ComponentAgent

See Also:

QueryAgent.as(Class), SelectAgent