Java Doc for IComponent.java in » J2EE » Jaffa » org » jaffa » presentation » portlet » component » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » J2EE » Jaffa » org.jaffa.presentation.portlet.component

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.jaffa.presentation.portlet.component .IComponent

All known Subclasses:   org.jaffa.presentation.portlet.component .Component,
IComponent
public interface IComponent (Code)
All the components implement this interface

Method Summary
public void addFormKeyChangeListener(FormKeyChangeListener listener)
     Registers listener so that it will receive FormKeyChangeEvents.
public FormKey display()
     Returns a FormKey, which has the componentId & the formName to which control should be passed
throws:
  FrameworkException - if any framework error occurs.
throws:
  ApplicationExceptions - if any application error occurs.
public ComponentDefinition getComponentDefinition()

public String getComponentId()

public FormKey getContainerFormKey()
     Getter for property containerFormKey. This property is useful when this component is being rendered as a tile inside another component. The outer component is expected to set this property on this component. The outer component is also expected to register the FormKeyChangeListener on this component. The ActionBase will intercept all FormKeys for this component.
public FormKeyChangeListener[] getFormKeyChangeListeners()
     Returns an array of all the FormKeyChangeListeners registered on this component.
public FormKey getReturnToFormKey()
     Getter for property returnToFormKey.
public String getToken()
     Getter for property token.
public UserSession getUserSession()

public boolean isActive()
     Returns a true if the component is still active.
public void quit()

public FormKey quitAndReturnToCallingScreen()
     This should invoke the quit() method, and then return the FormKey for the calling screen. The FormKey should have been set by a call to setReturnToFormKey(). The FormKey for the caling screen.
public void removeFormKeyChangeListener(FormKeyChangeListener listener)
     Unregisters listener so that it will no longer receive FormKeyChangeEvents.
public void setContainerFormKey(FormKey containerFormKey)
     Setter for property containerFormKey. This property is useful when this component is being rendered as a tile inside another component. The outer component is expected to set this property on this component. The outer component is also expected to register the FormKeyChangeListener on this component. The ActionBase will intercept all FormKeys for this component.
public void setReturnToFormKey(FormKey returnToFormKey)
     Setter for property returnToFormKey.
public void setToken(String token)
     Setter for property token.

Method Detail
addFormKeyChangeListener
public void addFormKeyChangeListener(FormKeyChangeListener listener)(Code)
Registers listener so that it will receive FormKeyChangeEvents. The ActionBase typically creates the FormKeyChangeEvent object, when processing an event for a component, that has a ContainerFormKey. It will then fire the FormKeyChangeListener registered with the component, passing the FormKeyChangeEvent object. The Component will fire the FormKeyChangeEvents on the listeners during the quit(), passing the ReturnToFormKey.
Parameters:
  listener - the FormKeyChangeListener to register.

display
public FormKey display() throws FrameworkException, ApplicationExceptions(Code)
Returns a FormKey, which has the componentId & the formName to which control should be passed
throws:
  FrameworkException - if any framework error occurs.
throws:
  ApplicationExceptions - if any application error occurs. the FormKey object

getComponentDefinition
public ComponentDefinition getComponentDefinition()(Code)
Returns the ComponentDefinition based on which this Component was created The ComponentDefintion object for the Component

getComponentId
public String getComponentId()(Code)
Returns the Id for the component The componentId

getContainerFormKey
public FormKey getContainerFormKey()(Code)
Getter for property containerFormKey. This property is useful when this component is being rendered as a tile inside another component. The outer component is expected to set this property on this component. The outer component is also expected to register the FormKeyChangeListener on this component. The ActionBase will intercept all FormKeys for this component. It will then fire the FormKeyChangeEvents on the listeners. The ActionBase will then return the ContainerFormKey. The Component will fire the FormKeyChangeEvents on the listeners during the quit(), passing the ReturnToFormKey. All this helps render the tiles correctly. Value of property containerFormKey.

getFormKeyChangeListeners
public FormKeyChangeListener[] getFormKeyChangeListeners()(Code)
Returns an array of all the FormKeyChangeListeners registered on this component. all of the component's FormKeyChangeListeners or a null if no ancestor listeners are currently registered.

getReturnToFormKey
public FormKey getReturnToFormKey()(Code)
Getter for property returnToFormKey. This FormKey determines the screen to display when quitting from a component. Value of property returnToFormKey.

getToken
public String getToken()(Code)
Getter for property token. Value of property token.

getUserSession
public UserSession getUserSession()(Code)
Returns the UserSession, under which the Component was created The UserSession object

isActive
public boolean isActive()(Code)
Returns a true if the component is still active. The component should be set to inactive status after a quit(). a true if the component is still active.

quit
public void quit()(Code)
This will kill all the Forms Finally de-register itself from the UserSession

quitAndReturnToCallingScreen
public FormKey quitAndReturnToCallingScreen()(Code)
This should invoke the quit() method, and then return the FormKey for the calling screen. The FormKey should have been set by a call to setReturnToFormKey(). The FormKey for the caling screen. A null will be returned, if no calling screen was specified.

removeFormKeyChangeListener
public void removeFormKeyChangeListener(FormKeyChangeListener listener)(Code)
Unregisters listener so that it will no longer receive FormKeyChangeEvents.
Parameters:
  listener - the FormKeyChangeListener to be removed.

setContainerFormKey
public void setContainerFormKey(FormKey containerFormKey)(Code)
Setter for property containerFormKey. This property is useful when this component is being rendered as a tile inside another component. The outer component is expected to set this property on this component. The outer component is also expected to register the FormKeyChangeListener on this component. The ActionBase will intercept all FormKeys for this component. It will then fire the FormKeyChangeEvents on the listeners. The ActionBase will then return the ContainerFormKey. The Component will fire the FormKeyChangeEvents on the listeners during the quit(), passing the ReturnToFormKey. All this helps render the tiles correctly.
Parameters:
  containerFormKey - New value of property containerFormKey.

setReturnToFormKey
public void setReturnToFormKey(FormKey returnToFormKey)(Code)
Setter for property returnToFormKey. This FormKey determines the screen to display when quitting from a component.
Parameters:
  returnToFormKey - New value of property returnToFormKey.

setToken
public void setToken(String token)(Code)
Setter for property token.
Parameters:
  token - New value of property token.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.