com.bea.netuix.servlets.controls.window
Class WindowMode

java.lang.Object
  com.bea.netuix.servlets.controls.Capability
      com.bea.netuix.servlets.controls.window.WindowMode

All Implemented Interfaces:

Serializable

public class WindowMode

extends Capability

implements Serializable

Represents a mode the window may be in. Modes can be enabled or disabled. If enabled, the window can display content from the mode's URI instead of the normal window content. A window can only be in one mode at time.
WindowMode extends Capability as the user needs to be entitled to set a Window into a particular mode.

See Also:

Serialized Form

Constructor Summary

WindowMode(String name, String contentUri)
Constructor - with mode enabled set to false

Method Summary

Object	clone() Create a exact copy of this object.
boolean	equals(WindowMode windowMode)
String	getAction() Get the action to run if the contentUri is for a PageFlow.
String	getBackingFile() Returns the backing file for this mode.
String	getContentUri() Get the uri for the content to be displayed when the window is in this mode.
String	getCurrentContentUri() Getter for the content uri currently in use.
String	getErrorUri() Get the uri for the content to be displayed on errors.
void	setAction(String action) If the contentUri is for a pageflow, there is an option to set the action to run when the pageflow is first entered.
void	setBackingFile(String backingFile) Sets the backing file for this mode.
void	setContentUri(String contentUri) Set the uri for the content to be displayed when the window is in this mode.
void	setCurrentContentUri(String currentContentUri) Setter for the content uri currently in use.
void	setErrorUri(String errorUri) Set the uri for the content to be displayed on errors.
String	toString() Returns this Capability as a String.

Methods inherited from class com.bea.netuix.servlets.controls.Capability

equals, equals, getName, isEntitlementsEnabled, setEntitlementsEnabled, setName

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WindowMode

public WindowMode(String name,
                  String contentUri)

Constructor - with mode enabled set to false

Method Detail

clone

public Object clone()

Create a exact copy of this object.

Returns:

a clone of the current WindowMode

equals

public boolean equals(WindowMode windowMode)

getAction

public String getAction()

Get the action to run if the contentUri is for a PageFlow. If the value is null, the default begin action will be used.

getBackingFile

public String getBackingFile()

Returns the backing file for this mode.

getContentUri

public String getContentUri()

Get the uri for the content to be displayed when the window is in this mode.

getCurrentContentUri

public String getCurrentContentUri()

Getter for the content uri currently in use.

getErrorUri

public String getErrorUri()

Get the uri for the content to be displayed on errors.

setAction

public void setAction(String action)

If the contentUri is for a pageflow, there is an option to set the action to run when the pageflow is first entered. If this value is null, the default begin action will be used.

Parameters:

action -

setBackingFile

public void setBackingFile(String backingFile)

Sets the backing file for this mode.

Parameters:

backingFile - backing file

setContentUri

public void setContentUri(String contentUri)

Set the uri for the content to be displayed when the window is in this mode.

setCurrentContentUri

public void setCurrentContentUri(String currentContentUri)

Setter for the content uri currently in use.

setErrorUri

public void setErrorUri(String errorUri)

Set the uri for the content to be displayed on errors.

toString

public String toString()

Description copied from class: Capability

Returns this Capability as a String.

Overrides:

toString in class Capability

Returns:

a String representation of this Capability