WindowMode Class
- 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.
-
Hierarchy
-
Object
Capability
WindowMode
-
All Implemented Interfaces
-
Serializable
WindowMode
public WindowMode(String
name,
String
contentUri)
- Constructor - with mode enabled set to false
clone() Method
public Object
clone()
Create a exact copy of this object.
-
Overrides
-
Object.clone()
Returns
- a clone of the current WindowMode
equals(WindowMode) Method
public boolean equals(WindowMode
windowMode)
getAction() Method
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() Method
public String
getBackingFile()
Returns the backing file for this mode.
getContentUri() Method
public String
getContentUri()
Get the uri for the content to be displayed when the window is in this mode.
getCurrentContentUri() Method
public String
getCurrentContentUri()
Getter for the content uri currently in use.
getErrorUri() Method
public String
getErrorUri()
Get the uri for the content to be displayed on errors.
setAction(String) Method
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.
setBackingFile(String) Method
public void setBackingFile(String
backingFile)
Sets the backing file for this mode.
Parameters
-
backingFile
- backing file
setContentUri(String) Method
public void setContentUri(String
contentUri)
Set the uri for the content to be displayed when the window is in this mode.
setCurrentContentUri(String) Method
public void setCurrentContentUri(String
currentContentUri)
Setter for the content uri currently in use.
setErrorUri(String) Method
public void setErrorUri(String
errorUri)
Set the uri for the content to be displayed on errors.
toString() Method
public String
toString()
Description copied from Capability.toString()
Returns this Capability
as a String
.
-
Overrides
-
Capability.toString()
Returns
- a
String
representation of this Capability