public class OwDocument extends OwEventTarget implements OwAttributeBagWriteable
Document Base Class. Documents can share several Views.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Field and Description |
---|---|
protected ArrayList |
m_ViewList
list of attached views if any
|
Constructor and Description |
---|
OwDocument() |
Modifier and Type | Method and Description |
---|---|
void |
attachView(OwUpdateTarget view_p)
attach a view to the document, which will receive onUpdate events when OwDocument.Update is called
|
int |
attributecount()
(implements OwAttributeBagWriteable) get non persistent attributes count
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
void |
clear()
(implements OwAttributeBagWriteable) clear non persistent attributes
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
void |
detachView(OwUpdateTarget view_p)
detach a view to the document, which will receive onUpdate events when OwDocument.Update is called
|
Object |
getAttribute(int iIndex_p)
(implements OwAttributeBagWriteable) get non persistent attribute
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
Object |
getAttribute(String strName_p)
(implements OwAttributeBagWriteable) get non persistent attribute
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
Collection |
getAttributeNames()
(implements OwAttributeBagWriteable) get non persistent attribute names
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
OwAttributeBagWriteable |
getPersistentAttributeBagWriteable()
(overridable) get a persistent OwAttributeBagWriteable (application scope)
NOTE: use the OwAttributeBagWriteable implementation of this class to access non persistent (session scope) scalars
|
Object |
getSafeAttribute(String strName_p,
Object default_p)
(implements OwAttributeBagWriteable) get non persistent attribute
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
boolean |
hasAttribute(String strName_p)
(implements OwAttributeBagWriteable) check for non persistent attribute
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
protected void |
init()
init the target after the context is set.
|
void |
remove(String strName_p)
(implements OwAttributeBagWriteable) remove non persistent attribute
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
void |
save()
(implements OwAttributeBagWriteable) save non persistent attributes, does nothing
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
void |
setAttribute(String strName_p,
Object value_p)
(implements OwAttributeBagWriteable) set non persistent attributes
NOTE: use getPersistentAttributeBagWriteable() to obtain a persistent OwAttributeBagWriteable
|
void |
update(OwEventTarget caller_p,
int iCode_p,
Object param_p)
causes all attached views to receive an onUpdate event
|
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
protected ArrayList m_ViewList
protected void init() throws Exception
init
in class OwEventTarget
Exception
public void attachView(OwUpdateTarget view_p)
view_p
- OwView to receive onUpdate eventspublic void detachView(OwUpdateTarget view_p)
view_p
- OwView to detachpublic void update(OwEventTarget caller_p, int iCode_p, Object param_p) throws Exception
caller_p
- OwEventTarget target that called updateiCode_p
- int optional reason codeparam_p
- Object optional parameter representing the refresh, depends on the value of iCode_p, can be nullException
public OwAttributeBagWriteable getPersistentAttributeBagWriteable() throws Exception
Exception
public void clear() throws Exception
clear
in interface OwAttributeBagWriteable
Exception
public void remove(String strName_p)
remove
in interface OwAttributeBagWriteable
strName_p
- String name of attributepublic void save() throws Exception
save
in interface OwAttributeBagWriteable
Exception
public void setAttribute(String strName_p, Object value_p) throws Exception
setAttribute
in interface OwAttributeBagWriteable
Exception
public int attributecount()
attributecount
in interface OwAttributeBag
public Object getAttribute(int iIndex_p) throws Exception
getAttribute
in interface OwAttributeBag
iIndex_p
- int indexException
public Object getAttribute(String strName_p) throws Exception
getAttribute
in interface OwAttributeBag
Exception
public Collection getAttributeNames()
getAttributeNames
in interface OwAttributeBag
public Object getSafeAttribute(String strName_p, Object default_p)
getSafeAttribute
in interface OwAttributeBag
public boolean hasAttribute(String strName_p)
hasAttribute
in interface OwAttributeBag
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.