Package net.webpdf.wsclient.schema.operation

Class ItemType

java.lang.Object

net.webpdf.wsclient.schema.operation.ItemReferenceType

net.webpdf.wsclient.schema.operation.ItemType

public class ItemType
extends ItemReferenceType

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to specify all the properties you want for a content structure entry that is to be created, including the actions it will trigger.
                     An entry can contain any number of the specified subelements you want in the order you want them. All subelements represent a type of action that will be triggered when the entry is clicked on and that will be executed in succession.
                 </p>
 

Java class for ItemType complex type

.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ItemType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}ItemReferenceType">
       <choice maxOccurs="unbounded" minOccurs="0">
         <element name="goTo" type="{http://schema.webpdf.de/1.0/operation}GoToDestinationActionType"/>
         <element name="launchApplication" type="{http://schema.webpdf.de/1.0/operation}LaunchApplicationActionType"/>
         <element name="resolveURI" type="{http://schema.webpdf.de/1.0/operation}URIActionType"/>
         <element name="playSound" type="{http://schema.webpdf.de/1.0/operation}SoundActionType"/>
         <element name="hideAnnotation" type="{http://schema.webpdf.de/1.0/operation}HideActionType"/>
         <element name="executeNamed" type="{http://schema.webpdf.de/1.0/operation}NamedActionType"/>
         <element name="submitForm" type="{http://schema.webpdf.de/1.0/operation}SubmitFormActionType"/>
         <element name="resetForm" type="{http://schema.webpdf.de/1.0/operation}ResetFormActionType"/>
         <element name="importSchema" type="{http://schema.webpdf.de/1.0/operation}ImportDataActionType"/>
         <element name="executeJavaScript" type="{http://schema.webpdf.de/1.0/operation}JavaScriptActionType"/>
         <element name="setLayerState" type="{http://schema.webpdf.de/1.0/operation}SetOCGStateActionType"/>
         <element name="setTransition" type="{http://schema.webpdf.de/1.0/operation}TransitionActionType"/>
         <element name="goTo3DView" type="{http://schema.webpdf.de/1.0/operation}GoTo3DViewActionType"/>
         <element name="goToThread" type="{http://schema.webpdf.de/1.0/operation}ThreadActionType"/>
       </choice>
       <attribute name="isOpen" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="italic" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="bold" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="color" type="{http://schema.webpdf.de/1.0/operation}RgbColorType" default="#000000" />
       <attribute name="pathPosition" type="{http://schema.webpdf.de/1.0/operation}AddPositionType" default="inplace" />
       <attribute name="itemName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ActionEventType>	actions
protected Boolean	bold	<?
protected String	color	<?
protected Boolean	isOpen	<?
protected Boolean	italic	<?
protected String	itemName	<?
protected AddPositionType	pathPosition	<?

Fields inherited from class net.webpdf.wsclient.schema.operation.ItemReferenceType

path

Constructor Summary

Constructors

Constructor	Description
ItemType()

Method Summary

Modifier and Type	Method	Description
List<ActionEventType>	getActions()	Gets the value of the actions property.
String	getColor()	<?
String	getItemName()	<?
AddPositionType	getPathPosition()	<?
boolean	isBold()	<?
boolean	isIsOpen()	<?
boolean	isItalic()	<?
boolean	isSetActions()
boolean	isSetBold()
boolean	isSetColor()
boolean	isSetIsOpen()
boolean	isSetItalic()
boolean	isSetItemName()
boolean	isSetPathPosition()
void	setBold(boolean value)	Sets the value of the bold property.
void	setColor(String value)	Sets the value of the color property.
void	setIsOpen(boolean value)	Sets the value of the isOpen property.
void	setItalic(boolean value)	Sets the value of the italic property.
void	setItemName(String value)	Sets the value of the itemName property.
void	setPathPosition(AddPositionType value)	Sets the value of the pathPosition property.
void	unsetActions()
void	unsetBold()
void	unsetIsOpen()
void	unsetItalic()

Methods inherited from class net.webpdf.wsclient.schema.operation.ItemReferenceType

getPath, isSetPath, setPath

Methods inherited from class java.lang.Object

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

Field Detail

actions

protected List<ActionEventType> actions

isOpen

protected Boolean isOpen

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the element will already be expanded when the document is opened.</p>
 

italic

protected Boolean italic

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the element's name will be shown in italics.</p>
 

bold

protected Boolean bold

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the element's name will be shown in bold.</p>
 

color

protected String color

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the colour that will be used to display the element's name. The hereby defined color needs to be specified as a hexadecimal RGB value with a number sign before it.</p>
 

pathPosition

protected AddPositionType pathPosition

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the position where the entry should be created. The path passed in "path" will be interpreted based on this value.
                                 <ul><li>before = An entry will be generated on the same level before the entry that was selected with "path.</li><li>inplace = The entry selected with "path" will be treated as a parent element and will contain the new generated entry.</li><li>after = An entry will be generated on the same level after the entry that was selected with "path.</li></ul></p>
 

itemName

protected String itemName

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The name of the new entry in the content structure that should be placed relative to the selected path.</p>
 

Constructor Detail

ItemType

public ItemType()

Method Detail

getActions

public List<ActionEventType> getActions()

Gets the value of the actions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the actions property.

For example, to add a new item, do as follows:

 getActions().add(newItem);
 

Objects of the following type(s) are allowed in the list GoTo3DViewActionType GoToDestinationActionType HideActionType ImportDataActionType JavaScriptActionType LaunchApplicationActionType NamedActionType ResetFormActionType SetOCGStateActionType SoundActionType SubmitFormActionType ThreadActionType TransitionActionType URIActionType

Returns:

The value of the actions property.

isSetActions

public boolean isSetActions()

unsetActions

public void unsetActions()

isIsOpen

public boolean isIsOpen()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the element will already be expanded when the document is opened.</p>
 

Returns:

possible object is Boolean

setIsOpen

public void setIsOpen(boolean value)

Sets the value of the isOpen property.

Parameters:

value - allowed object is Boolean

See Also:

isIsOpen()

isSetIsOpen

public boolean isSetIsOpen()

unsetIsOpen

public void unsetIsOpen()

isItalic

public boolean isItalic()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the element's name will be shown in italics.</p>
 

Returns:

possible object is Boolean

setItalic

public void setItalic(boolean value)

Sets the value of the italic property.

Parameters:

value - allowed object is Boolean

See Also:

isItalic()

isSetItalic

public boolean isSetItalic()

unsetItalic

public void unsetItalic()

isBold

public boolean isBold()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to true, the element's name will be shown in bold.</p>
 

Returns:

possible object is Boolean

setBold

public void setBold(boolean value)

Sets the value of the bold property.

Parameters:

value - allowed object is Boolean

See Also:

isBold()

isSetBold

public boolean isSetBold()

unsetBold

public void unsetBold()

getColor

public String getColor()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the colour that will be used to display the element's name. The hereby defined color needs to be specified as a hexadecimal RGB value with a number sign before it.</p>
 

Returns:

possible object is String

setColor

public void setColor(String value)

Sets the value of the color property.

Parameters:

value - allowed object is String

See Also:

getColor()

isSetColor

public boolean isSetColor()

getPathPosition

public AddPositionType getPathPosition()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the position where the entry should be created. The path passed in "path" will be interpreted based on this value.
                                 <ul><li>before = An entry will be generated on the same level before the entry that was selected with "path.</li><li>inplace = The entry selected with "path" will be treated as a parent element and will contain the new generated entry.</li><li>after = An entry will be generated on the same level after the entry that was selected with "path.</li></ul></p>
 

Returns:

possible object is AddPositionType

setPathPosition

public void setPathPosition(AddPositionType value)

Sets the value of the pathPosition property.

Parameters:

value - allowed object is AddPositionType

See Also:

getPathPosition()

isSetPathPosition

public boolean isSetPathPosition()

getItemName

public String getItemName()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The name of the new entry in the content structure that should be placed relative to the selected path.</p>
 

Returns:

possible object is String

setItemName

public void setItemName(String value)

Sets the value of the itemName property.

Parameters:

value - allowed object is String

See Also:

getItemName()

isSetItemName

public boolean isSetItemName()