org.jboss.portal.server
Class Window

java.lang.Object
  org.jboss.portal.server.kernel.BaseService
      org.jboss.portal.server.ServerObject
          org.jboss.portal.server.Window

All Implemented Interfaces:

PluginContainer, Registration, Service

public class Window
extends ServerObject

The placement of a component instance on the page.

Field Summary

protected Instance	instance
protected WindowMetaData	metaData
protected Portal	portal

Fields inherited from class org.jboss.portal.server.ServerObject

log, name, plugins

Fields inherited from class org.jboss.portal.server.kernel.BaseService

ctx

Constructor Summary

Window(WindowMetaData metaData)

Method Summary

void	addIDependOn(ServiceImplementation implementation) Add a service it depends on.
ServerObjectContext	createContext() Create and returns a context object.
ServerURL	createURL() Create a new URL for that will target this object.
Instance	getInstance() Return the instance associed to this window.
ServerObjectMetaData	getMetaData() Return the meta data for that object.
Portal	getPortal() Return the portal this instance belongs to.
PortalServer	getServer() Return the container this object belongs to.
java.util.Collection	getSupportedModes(java.lang.String contentType) Return the set portlet modes allowed by this portlet window.
java.util.Set	getSupportedWindowStates() Return the set window states allowed by this portlet window.
boolean	isSupportedMode(java.lang.String contentType, Mode mode) Return true if the given content type is supported for the given mode.
boolean	isSupportedWindowState(WindowState windowState)
void	removeIDependOn(ServiceImplementation implementation) Remove a service it depends on.

Methods inherited from class org.jboss.portal.server.ServerObject

addDependsOnMe, addPlugin, create, destroy, getID, getName, getPlugin, getPluginKeySet, invoke, removeDependsOnMe, removePlugin, start, stop

Methods inherited from class org.jboss.portal.server.kernel.BaseService

registered, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.portal.server.kernel.Registration

registered, unregister

Field Detail

portal

protected Portal portal

instance

protected Instance instance

metaData

protected WindowMetaData metaData

Constructor Detail

Window

public Window(WindowMetaData metaData)

Method Detail

createContext

public ServerObjectContext createContext()

Description copied from class: ServerObject

Create and returns a context object.

Overrides:

createContext in class ServerObject

Returns:

a context object

getMetaData

public ServerObjectMetaData getMetaData()

Description copied from class: ServerObject

Return the meta data for that object.

Specified by:

getMetaData in class ServerObject

getServer

public PortalServer getServer()

Description copied from class: ServerObject

Return the container this object belongs to.

Specified by:

getServer in class ServerObject

getPortal

public Portal getPortal()

Return the portal this instance belongs to.

getInstance

public Instance getInstance()

Return the instance associed to this window.

addIDependOn

public void addIDependOn(ServiceImplementation implementation)

Description copied from interface: Registration

Add a service it depends on.

Specified by:

addIDependOn in interface Registration

Overrides:

addIDependOn in class ServerObject

removeIDependOn

public void removeIDependOn(ServiceImplementation implementation)

Description copied from interface: Registration

Remove a service it depends on.

Specified by:

removeIDependOn in interface Registration

Overrides:

removeIDependOn in class ServerObject

getSupportedModes

public java.util.Collection getSupportedModes(java.lang.String contentType)

Return the set portlet modes allowed by this portlet window.

isSupportedMode

public boolean isSupportedMode(java.lang.String contentType,
                               Mode mode)

Return true if the given content type is supported for the given mode.

Throws:

java.lang.IllegalArgumentException - if the content type or the mode is null

isSupportedWindowState

public boolean isSupportedWindowState(WindowState windowState)

Throws:

java.lang.IllegalArgumentException - if the window state is null

getSupportedWindowStates

public java.util.Set getSupportedWindowStates()

Return the set window states allowed by this portlet window.

createURL

public ServerURL createURL()

Description copied from class: ServerObject

Create a new URL for that will target this object.

Overrides:

createURL in class ServerObject