|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AcsFactoryForAcsAddon
This interface is responsible for describing an AcsFactory in the gWork package of an AcsAddon. It is used for creating the ACS of any AcsAddon.
The descriptor of the AcsAddon, to set in the menu for creating a new ACS, is returned by the method getPublicAcsAddonName().
Caution: This property has to be defined in every implementation of this interface.
The BaseManagerImpl class, in the generic gBase package, is responsible to return the method getL_AcsAddonDescriptors() describing all the ACS addon editors and names. In this returned list, the form of a value is 'Editor: editor_name - AcsAddon: addon_name'. BaseManagerImpl checks that the 4 standard directories of an AcsAddon are there in the packages tree. These directories are gBase, gBaseBeanInfo, gBaseInterface, and gWork. It also controls that the standard file AcsFactoryXXX is in the directory 'gWork', where 'XXX' is the AcsAddon name. Otherwise, the BaseManagerImpl instance cannot be initialized, an error message is thrown and the program stops.
An AcsAddon must have a 'acsaddon_guide.html' file in the AcsAddon gBase directory, as the first user guide. In this same directory, it may provide an icon for the ACS, at the format JPEG. There is no explicit management of the AcsAddon version, but is is possible to add a version number in the AcsAddon name.
for the definition of the ACS type
Method Summary | |
---|---|
ACSImpl |
configure(ACSImpl _result)
Creates the initial components in a new ACS. |
ACSImpl |
create(ImmutableName _iSname,
ImmutableName _name,
java.lang.String _type,
ImmutableName _parent)
Creates a specific ACS for an AcsAddon. |
java.lang.String |
getPublicAcsAddonName()
Gets the descriptor of the AcsAddon, to set in the menu for creating a new ACS. |
Method Detail |
---|
ACSImpl create(ImmutableName _iSname, ImmutableName _name, java.lang.String _type, ImmutableName _parent) throws BaseError
_iSname
- the IS of the new ACS. May be null._name
- of the ACS to create or open.
No test of null value nor empty._type
- must be the right type for the AcsAddon_parent
- is the parent node of the new ACS in the IS. Never null.
BaseError
- if the ACS is known, the ACS is open,
the core ACS is null when it is mandatory, or
ClassNotFoundException, IOException with
invalidClassException if the ACSImpl class HAS CHANGED,
or if the type or the specified structure are not correct.ACSImpl configure(ACSImpl _result)
_result
- to construct
java.lang.String getPublicAcsAddonName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |