com.ihr.xbrl.om.renderhints

Class RenderHints

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.exLinks.XLinkElement

com.ihr.xbrl.om.exLinks.XBRLPointerOfARelationship

com.ihr.xbrl.om.exLinks.XBRLResource

com.ihr.xbrl.om.renderhints.RenderHints

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, XBRLValidation, XBRLValueKey, java.io.Serializable, java.lang.Cloneable, javax.xml.namespace.NamespaceContext, javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.FingerprintedNode, net.sf.saxon.om.Item, net.sf.saxon.om.MutableNodeInfo, net.sf.saxon.om.NamespaceResolver, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>, net.sf.saxon.tree.wrapper.SiblingCountingNode

public class RenderHints
extends XBRLResource

This is the render hints resource that applies to one XBRLRoleType.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ihr.xbrl.om.XMLFragment

XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

XBRLValidation.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	renderingHintsNode The Constant renderingHintsNode.

Fields inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

log, nullResource

Fields inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

actuate, ARC, arcrole, ETITLE, EXTENDED, from, href, label, LOCATOR, RESOURCE, role, show, SIMPLE, title, to, X_ACTUATE, X_ARCROLE, X_FROM, X_HREF, X_LABEL, X_ROLE, X_SHOW, X_TITLE, X_TO, X_TYPE, XLINKPREFIX

Fields inherited from class com.ihr.xbrl.om.XMLFragment

ADD_NAMESPACE_INHERIT, baseQName, CONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, FACT_VALUE, HIDE_COMMON_ACCURACY, idQName, langQName, nil, NO_POSITION, OrderComparator, OrderComparator2, OrderComparatorReverse, PERIOD_BOP, PERIOD_TYPE, PERIOD_VALUE, RELATIONSHIP_TYPE, RESOURCE_TYPE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

NODE_LETTER

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
RenderHints(XBRLExtendedLink parent) Constructs a new RenderHints empty resource.
RenderHints(XBRLExtendedLink parent, boolean bAddToParent) Instantiates a new render hints.
RenderHints(XBRLExtendedLink parent, XMLFragment resNode) Instantiates a new render hints.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
RenderHints	generateNode() Generate node.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
int	getPreferredIndex(XBRLItem primaryItem, Dimension<?> dim) Gets the preferred index.
int	getPreferredPosition(XBRLItem primaryItem, Dimension<?> dim) Gets the preferred position.
javax.xml.namespace.QName	getPrimaryItem() Gets the primary item.
int	getViewMode() Gets the view mode.
boolean	hasChildNodes()
boolean	isComplexType() Checks if is complex type.
boolean	isPreferred() Checks if is preferred.
static RenderHints	make(XBRLResource other) Make.
void	setAxisDimension(java.lang.String axis, int order, javax.xml.namespace.QName name) Sets the axis dimension.
void	setPreferred(boolean value) Sets the preferred.
void	setPrimary(javax.xml.namespace.QName primary) Sets the primary.
void	setViewMode(int viewMode) Sets the view mode to a new value.

Methods inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

addChild, clone, clone, equals, getAttributes, getCode, getDTSBase, getFriendlyName, getFriendlyName, getFriendlyName, getParentXBRL, getResourceIdentifier, getRoleType, getType, getValidationReport, getValueKey, hashCode, invalidate, invalidate, isHashDependsOnAtribute, isOnValidation, isSimpleType, setCode, setComplexType, setDTSBase, setId, setRawParentXBRL, setRole, setRoleType, setSimpleType, setValue, validate

Methods inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

getActuate, getArcrole, getFromTxt, getHRef, getHRefDocument, getHRefDocumentResolved, getHRefResolved, getLabel, getRawHRef, getReference, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo, validateXPointer

Methods inherited from class com.ihr.xbrl.om.XMLFragment

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, commitBatch, copy, createComment, delAttribute, delAttribute, delete, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generatePrefix, getAllAttributes, getAttribute, getAttributeAtomicValue, getAttributeBooleanValue, getAttributeGroundedValue, getAttributeQNameValue, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getElements, getFirstChildNoComment, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentDocument, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isNamespaceDefined, isNil, moveNamespacesUp, objEquals, objHashCode, reindex, removeChild, removeChildNode, removeFromRelationship, removeNamespace, removePropertyChangeListener, removeToRelationship, replace, replaceChild, replaceStringValue, resetElements, resolveHRef, s_equal2_xp2, s_equal2_xp2, s_equal2, s_equal2, s_equal2, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, valueEquals, xEqual

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

addAttribute, addNamespace, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, isId, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, setLocation, setNameCode, setNamespaceList, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

atomize, compareOrder, comparePosition, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getSuccessorElement, getURI, head, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterate, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

renderingHintsNode

public static final javax.xml.namespace.QName renderingHintsNode

The Constant renderingHintsNode.

Constructor Detail

RenderHints

public RenderHints(XBRLExtendedLink parent,
                   XMLFragment resNode)

Instantiates a new render hints.

Parameters:

parent - the parent

resNode - the res node

RenderHints

public RenderHints(XBRLExtendedLink parent)

Constructs a new RenderHints empty resource. Before saving it is required to set all information programatically. Otherwise serialization will raise an XBRLSerializationException

Parameters:

parent - the generic linkbase where this resource belong to and will be serialized

RenderHints

public RenderHints(XBRLExtendedLink parent,
                   boolean bAddToParent)

Instantiates a new render hints.

Parameters:

parent - the parent

bAddToParent - the b add to parent

Method Detail

make

public static RenderHints make(XBRLResource other)

Make.

Parameters:

other - the other

Returns:

the render hints

setViewMode

public void setViewMode(int viewMode)

Sets the view mode to a new value. Values are constants defined in the InstanceDocumentPane class

Parameters:

viewMode - the new view mode

generateNode

public RenderHints generateNode()
                         throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XBRLResource

Returns:

the render hints

Throws:

XBRLSerializationException - the XBRL serialization exception

isComplexType

public boolean isComplexType()

Checks if is complex type.

Overrides:

isComplexType in class XBRLResource

Returns:

true, if is complex type

getViewMode

public int getViewMode()

Gets the view mode.

Returns:

the view mode

setPreferred

public void setPreferred(boolean value)

Sets the preferred.

Parameters:

value - the new preferred

isPreferred

public boolean isPreferred()

Checks if is preferred.

Returns:

true, if is preferred

setPrimary

public void setPrimary(javax.xml.namespace.QName primary)

Sets the primary.

Parameters:

primary - the new primary

setAxisDimension

public void setAxisDimension(java.lang.String axis,
                             int order,
                             javax.xml.namespace.QName name)

Sets the axis dimension.

Parameters:

axis - the axis

order - the order

name - the name

getPreferredPosition

public int getPreferredPosition(XBRLItem primaryItem,
                                Dimension<?> dim)

Gets the preferred position.

Parameters:

primaryItem - the primary item

dim - the dim

Returns:

the preferred position

getPreferredIndex

public int getPreferredIndex(XBRLItem primaryItem,
                             Dimension<?> dim)

Gets the preferred index.

Parameters:

primaryItem - the primary item

dim - the dim

Returns:

the preferred index

getPrimaryItem

public javax.xml.namespace.QName getPrimaryItem()

Gets the primary item.

Returns:

the primary item

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XBRLResource

Throws:

java.lang.Throwable - the throwable

hasChildNodes

public final boolean hasChildNodes()

Specified by:

hasChildNodes in interface net.sf.saxon.om.NodeInfo

Overrides:

hasChildNodes in class net.sf.saxon.tree.linked.NodeImpl

getNumberOfChildren

public final int getNumberOfChildren()

getFirstChild

public final net.sf.saxon.tree.linked.NodeImpl getFirstChild()

Specified by:

getFirstChild in interface net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>

Overrides:

getFirstChild in class net.sf.saxon.tree.linked.NodeImpl

getLastChild

public final net.sf.saxon.tree.linked.NodeImpl getLastChild()

Overrides:

getLastChild in class net.sf.saxon.tree.linked.NodeImpl