org.openmdx.portal.servlet.view
Class View

java.lang.Object
  org.openmdx.portal.servlet.view.View

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ObjectView, UserDefinedView

public abstract class View
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

protected ApplicationContext	application
protected String	containerElementId
protected ControlFactory	controlFactory
protected String	id
protected Object[]	macro
protected Object	object
static short	REQUEST_ID_FORMAT_NONE
static short	REQUEST_ID_FORMAT_TEMPLATE
static short	REQUEST_ID_FORMAT_UID
static String	REQUEST_ID_TEMPLATE
protected String	requestId
protected Action[]	setGuiModeActions
static String	VIEW_EDIT_OBJECT
static String	VIEW_SHOW_OBJECT
static String	VIEW_USER_DEFINED

Constructor Summary

View(String id, String containerElementId, Object object, ApplicationContext application, ControlFactory controlFactory)
Creates view.

Method Summary

Control	createControl(String id, Class controlClass)
Control	createControl(String id, Class controlClass, Object[] parameter)
void	createRequestId()
ApplicationContext	getApplicationContext()
String	getContainerElementId()
ControlFactory	getControlFactory()
String	getEncodedHRef(Action action)
String	getEncodedHRef(Action action, boolean includeRequestId)
String	getEncodedHRef(Action action, short requestIdFormat)
String	getEvalHRef(Action action)
String	getEvalHRef(Action action, boolean includeRequestId)
String	getEvalHRef(Action action, short requestIdFormat)
Action	getFindObjectAction(String feature, String id)
String	getId() Each view has an id and a childId.
Action	getLogoffAction()
Object[]	getMacro()
Object	getObject()
int	getPanelState(String panelName)
Action[]	getQuickAccessActions()
String	getRequestId()
Action	getSaveSettingsAction()
Action[]	getSelectRootObjectActions()
Action[]	getSetGuiModeActions()
Action	getSetPanelStateAction(String panelName, int panelState)
Action[]	getSetRoleActions()
abstract String	getType()
void	handleCanNotCommitException(org.openmdx.kernel.exception.BasicException e)
void	refresh(boolean refreshData) Refresh view.
void	setMacro(Object[] newValue)
void	structToMap(javax.jmi.reflect.RefStruct from, Map to, org.openmdx.model1.accessor.basic.cci.ModelElement_1_0 structDef)

Methods inherited from class java.lang.Object

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

Field Detail

VIEW_EDIT_OBJECT

public static final String VIEW_EDIT_OBJECT

See Also:

Constant Field Values

VIEW_SHOW_OBJECT

public static final String VIEW_SHOW_OBJECT

See Also:

Constant Field Values

VIEW_USER_DEFINED

public static final String VIEW_USER_DEFINED

See Also:

Constant Field Values

REQUEST_ID_TEMPLATE

public static final String REQUEST_ID_TEMPLATE

See Also:

Constant Field Values

REQUEST_ID_FORMAT_NONE

public static final short REQUEST_ID_FORMAT_NONE

See Also:

Constant Field Values

REQUEST_ID_FORMAT_UID

public static final short REQUEST_ID_FORMAT_UID

See Also:

Constant Field Values

REQUEST_ID_FORMAT_TEMPLATE

public static final short REQUEST_ID_FORMAT_TEMPLATE

See Also:

Constant Field Values

application

protected final ApplicationContext application

controlFactory

protected final ControlFactory controlFactory

id

protected final String id

containerElementId

protected final String containerElementId

object

protected Object object

requestId

protected String requestId

setGuiModeActions

protected Action[] setGuiModeActions

macro

protected Object[] macro

Constructor Detail

View

public View(String id,
            String containerElementId,
            Object object,
            ApplicationContext application,
            ControlFactory controlFactory)

Creates view.

Parameters:

id - id of the view

containerElementId - id of the container element if the view is embedded in another view. null if the view is a not embedded. The containerElementId is used by controls to create unique tag ids.

object - object to be rendered

application - application context

controlFactory - factory used to created new controls

Method Detail

getType

public abstract String getType()

createRequestId

public void createRequestId()

getRequestId

public String getRequestId()

getApplicationContext

public ApplicationContext getApplicationContext()

getLogoffAction

public Action getLogoffAction()

getSaveSettingsAction

public Action getSaveSettingsAction()

getSetRoleActions

public Action[] getSetRoleActions()

getQuickAccessActions

public Action[] getQuickAccessActions()

getMacro

public Object[] getMacro()

setMacro

public void setMacro(Object[] newValue)

getSelectRootObjectActions

public Action[] getSelectRootObjectActions()

getSetPanelStateAction

public Action getSetPanelStateAction(String panelName,
                                     int panelState)

getSetGuiModeActions

public Action[] getSetGuiModeActions()

getPanelState

public int getPanelState(String panelName)

getId

public String getId()

Each view has an id and a childId. Normally all views of the same 'layer' have the same id, i.e. a view which creates a 'next' view inherits the id. getChild(), createNewChild() allows the create new view layers.

A JSP wants to create a ShowObject dialog in a new window. This can be done by creating a new child id and then issuing an event (e.g. EVENT_FIND_OBJECT) which creates a view with the new child id.

getContainerElementId

public String getContainerElementId()

Returns:

id of the container element if the view is embedded, null otherwise

structToMap

public void structToMap(javax.jmi.reflect.RefStruct from,
                        Map to,
                        org.openmdx.model1.accessor.basic.cci.ModelElement_1_0 structDef)
                 throws org.openmdx.base.accessor.jmi.cci.JmiServiceException

Throws:

org.openmdx.base.accessor.jmi.cci.JmiServiceException

handleCanNotCommitException

public void handleCanNotCommitException(org.openmdx.kernel.exception.BasicException e)

refresh

public void refresh(boolean refreshData)
             throws org.openmdx.base.exception.ServiceException

Refresh view. refreshData ==> do refresh data. Do not refresh rendering information.

Throws:

org.openmdx.base.exception.ServiceException

createControl

public Control createControl(String id,
                             Class controlClass)
                      throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

createControl

public Control createControl(String id,
                             Class controlClass,
                             Object[] parameter)
                      throws org.openmdx.base.exception.ServiceException

Throws:

org.openmdx.base.exception.ServiceException

getControlFactory

public ControlFactory getControlFactory()

getObject

public Object getObject()

getEvalHRef

public String getEvalHRef(Action action)

getEvalHRef

public String getEvalHRef(Action action,
                          boolean includeRequestId)

getEvalHRef

public String getEvalHRef(Action action,
                          short requestIdFormat)

getEncodedHRef

public String getEncodedHRef(Action action)

getEncodedHRef

public String getEncodedHRef(Action action,
                             boolean includeRequestId)

getEncodedHRef

public String getEncodedHRef(Action action,
                             short requestIdFormat)

getFindObjectAction

public Action getFindObjectAction(String feature,
                                  String id)