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 and if enabled the window can diplay the modes specific URL instead of it's normal 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

protected	WindowMode(com.bea.netuix.nf.state.ControlStateReader reader) Constructs a window mode from the given reader.
	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() If the contentUri is a pageflow, there is an option to set the action to run.
String	getBackingFile() Returns the backing file for this mode.
String	getContentUri() Getter for the content uri when the window is in this mode.
String	getCurrentContentUri() Getter for the current content uri
String	getErrorUri() Getter for error url.
void	setAction(String action) If the contentUri is a pageflow, there is an option to set the action to run.
void	setBackingFile(String backingFile) Sets the backing file for this mode.
void	setContentUri(String contentUri) Setter for alternate content url.
void	setCurrentContentUri(String currentContentUri) Setter for the current content uri
void	setErrorUri(String errorUri) Setter for error url.
String	toString() Returns a string.
protected void	write(com.bea.netuix.nf.state.ControlStateWriter writer) Writes the state to the writer.

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

Parameters:

name - of this mode (must be unique)

contentUri - optional url the window will render if this mode is enabled

WindowMode

protected WindowMode(com.bea.netuix.nf.state.ControlStateReader reader)

Constructs a window mode from the given reader.

Parameters:

reader - reader

Method Detail

getContentUri

public String getContentUri()

Getter for the content uri when the window is in this mode.

setContentUri

public void setContentUri(String contentUri)

Setter for alternate content url.

getErrorUri

public String getErrorUri()

Getter for error url.

setErrorUri

public void setErrorUri(String errorUri)

Setter for error url.

getCurrentContentUri

public String getCurrentContentUri()

Getter for the current content uri

setCurrentContentUri

public void setCurrentContentUri(String currentContentUri)

Setter for the current content uri

getBackingFile

public String getBackingFile()

Returns the backing file for this mode.

setBackingFile

public void setBackingFile(String backingFile)

Sets the backing file for this mode.

Parameters:

backingFile - backing file

clone

public Object clone()

Create a exact copy of this object.

Overrides:

clone in class Object

Returns:

a clone of the current WindowMode

equals

public boolean equals(WindowMode windowMode)

toString

public String toString()

Description copied from class: Capability

Returns a string.

Overrides:

toString in class Capability

Returns:

string

getAction

public String getAction()

If the contentUri is a pageflow, there is an option to set the action to run. If null, will default to begin.

setAction

public void setAction(String action)

If the contentUri is a pageflow, there is an option to set the action to run. If null, will default to begin.

Parameters:

action -

write

protected void write(com.bea.netuix.nf.state.ControlStateWriter writer)

Writes the state to the writer.

Parameters:

writer - writer