Modifier and Type | Field and Description |
---|---|
static int |
ADD_TO_PROJECT_CMD_ID |
static int |
ADD_URL_TO_PROJECT_CMD_ID |
static int |
FAILED
Indicates that the command failed because content could not be added
to the content set.
|
Constructor and Description |
---|
AddContentCommand()
Creates the AddContentCommand.
|
Modifier and Type | Method and Description |
---|---|
static void |
addToProject(Context context,
java.lang.String contentSetKey)
Deprecated.
|
static void |
addToProject(Node[] nodes,
Project project,
java.lang.String contentSetKey)
Deprecated.
|
static void |
addToProject(Node node,
Project project,
java.lang.String contentSetKey)
Deprecated.
|
int |
doit()
Executes the
AddContentCommand , which gets the
Node from the active context and adds it to
the project. |
int |
doit(boolean includeSubFolders)
Executes the
AddContentCommand , which gets the
Node from the active context and adds it to
the project. |
int |
doit(java.lang.String contentSetKey)
Executes the
AddContentCommand , which gets the
Node from the active context and adds it to
the project. |
int |
doit(java.lang.String contentSetKey,
boolean includeSubFolders)
Executes the
AddContentCommand , which gets the
Node from the active context and adds it to the
project. |
static void |
registerPreferredContentSet(java.lang.Class nodeClass,
java.lang.String contentSetKey)
Registers the content set identified by the content set key
as the preferred content set to which to add nodes of the supplied
class type.
|
static void |
unRegisterPreferredContentSet(java.lang.Class nodeClass,
java.lang.String contentSetKey)
Unregisters the node of the supplied class type with the content
set key.
|
enableConfirmation, getAffectedNodes, getContext, getData, getId, getName, getProgressHandle, getType, isGlobal, setContext, setData, setTaskInfo, undo
public static final int ADD_URL_TO_PROJECT_CMD_ID
public static final int ADD_TO_PROJECT_CMD_ID
public static final int FAILED
public static void registerPreferredContentSet(java.lang.Class nodeClass, java.lang.String contentSetKey)
nodeClass
- the node typecontentSetKey
- the unique content set keypublic static void unRegisterPreferredContentSet(java.lang.Class nodeClass, java.lang.String contentSetKey)
nodeClass
- the node typecontentSetKey
- the unique content set keypublic static void addToProject(Node node, Project project, java.lang.String contentSetKey)
Project.add(Node, String)
or
Project.add(Node[], String)
public static void addToProject(Node[] nodes, Project project, java.lang.String contentSetKey)
Project.add(Node, String)
or
Project.add(Node[], String)
public static void addToProject(Context context, java.lang.String contentSetKey)
Project.add(Node, String)
or
Project.add(Node[], String)
public int doit(boolean includeSubFolders) throws java.lang.Exception
AddContentCommand
, which gets the
Node
from the active context and adds it to
the project. Clients should call setContext(Context)
after creating the command. If the Node
in the
context cannot be "unexcluded" from an existing content
set, the user will be prompted to choose the content set to which
to add the Node
.includeSubFolders
- indicates whether or not subfolders
are added (ignored if the supplied url is a file)Node
was restored or added
to the project, CANCEL if the user canceled the command, or
FAILED if the Node
could not be added to the
projectjava.lang.Exception
doit(String)
,
doit(String, boolean)
public int doit(java.lang.String contentSetKey) throws java.lang.Exception
AddContentCommand
, which gets the
Node
from the active context and adds it to
the project. Clients should call setContext(Context)
after creating the command. If hte Node
cannot
be restored from the content set identified by
contentSetKey
, the content will be added to a new
content folder.contentSetKey
- the data key for the content set to which
the Node should be addedNode
was restored or added
to the project, CANCEL if the user canceled the command, or
FAILED if the Node
could not be added to the
projectjava.lang.Exception
doit()
,
doit(boolean)
,
doit(String)
public int doit(java.lang.String contentSetKey, boolean includeSubFolders) throws java.lang.Exception
AddContentCommand
, which gets the
Node
from the active context and adds it to the
project. Clients should call setContext(Context)
after
creating the command.contentSetKey
- the data key for the content set to which the
Node should be addedincludeSubFolders
- indicates whether or not subfolders
are added (ignored if the supplied url is a file)Node
was restored or added
to the project, CANCEL if the user canceled the command, or
FAILED if the Node
could not be added to the
projectjava.lang.Exception
java.lang.IllegalArgumentException
- if contentSetKey
is not a valid keyCommand.OK
,
Command.CANCEL
public int doit() throws java.lang.Exception
AddContentCommand
, which gets the
Node
from the active context and adds it to
the project. Clients should call setContext(Context)
after creating the command.doit
in class Command
Node
was restored or added
to the project, CANCEL if the user canceled the command, or
FAILED if the Node
could not be added to the
projectjava.lang.Exception
doit(boolean)
,
doit(String)
,
doit(String, boolean)