Java Doc for FormatSupport.java in  » IDE-Netbeans » editor » org » netbeans » editor » ext » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Netbeans » editor » org.netbeans.editor.ext   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.netbeans.editor.ext.FormatSupport All known Subclasses:   org.netbeans.editor.ext.ExtFormatSupport, FormatSupport public class FormatSupport (Code) Format support presents a set of operations over the format-writer that is specific for the given set of formatting layers. It presents the way how to extend the low level methods offered by the format-writer. In general there can be more format-layers that use one type of the format-support. author:    Miloslav Metelka version:    1.00 Constructor Summary public   FormatSupport(FormatWriter formatWriter)      Method Summary public  boolean canInsertToken(TokenItem beforeToken)      Delegation to the same method in format-writer. public  boolean canModifyWhitespace(TokenItem inToken)      Check whether the given token enables modifying of a whitespace in it. public  boolean canRemoveToken(TokenItem token)      Whether the token-item can be removed. public  boolean canReplaceToken(TokenItem token)      Whether the given token can be replaced or not. public  String chainToString(TokenItem token)      Debug the current state of the chain. Parameters:   token - mark this token as current one. public  String chainToString(TokenItem token, int maxDocumentTokens)      public  FormatTokenPosition changeLineIndent(FormatTokenPosition pos, int indent)      Change the indentation of the line. public  boolean expandTabs()      public  TokenItem findFirstToken(TokenItem token)      Get the first token in chain. public  FormatTokenPosition findLineEnd(FormatTokenPosition pos)      Get the ending position of the line. public  FormatTokenPosition findLineEndWhitespace(FormatTokenPosition pos)      Return the ending whitespace on the line or null if there's no such token on the given line. public  FormatTokenPosition findLineFirstNonWhitespace(FormatTokenPosition pos)      Return the first non-whitespace character on the line or null if there is no non-WS char on the line. public  FormatTokenPosition findLineStart(FormatTokenPosition pos)      Get the starting position of the line. public  FormatTokenPosition findNextEOL(FormatTokenPosition pos)      Get the first EOL in forward direction. Parameters:   pos - starting token-position that is ignored by the searchso it can be even EOL. public  TokenItem findNonEmptyToken(TokenItem token, boolean backward)      Check whether the given token has empty text and if so start searching for token with non-empty text in the given direction. public  FormatTokenPosition findNonWhitespace(FormatTokenPosition startPosition, FormatTokenPosition limitPosition, boolean stopOnEOL, boolean backward)      Get the first non-whitespace position in the given direction. Parameters:   startPosition - position at which the search starts.For the backward search the character right at startPositionis not considered as part of the search. Parameters:   limitPosition - the token where the search will be brokenreporting that nothing was found. public  FormatTokenPosition findPreviousEOL(FormatTokenPosition pos)      Get the first EOL in backward direction. public  FormatTokenPosition getFormatStartPosition()      Delegation to the same method in format-writer. public  FormatWriter getFormatWriter()      Getter for the format-writer associated with this format-support. public  int getIndentShift()      Delegation to the same method in format-writer. public  String getIndentString(int indent)      This delegates to the same method in formatter. public  FormatTokenPosition getLastPosition()      public  TokenItem getLastToken()      Delegation to the same method in format-writer. public  int getLineIndent(FormatTokenPosition pos, boolean zeroForWSLine)      Get the indentation of the line. Parameters:   formatTokenPosition - any position on the line.It doesn't have to be the first one. Parameters:   zeroForWSLine - If set to true the method will return zeroin case the line consist of whitespace only. public  FormatTokenPosition getNextPosition(TokenItem token, int offset, Position.Bias bias)      Get the next position of the position given by parameters. public  FormatTokenPosition getNextPosition(FormatTokenPosition pos)      Get the next successive token-position after the given one. public  FormatTokenPosition getNextPosition(FormatTokenPosition pos, Position.Bias bias)      Get the token-position preceeding the given one. public  FormatTokenPosition getNextPosition(TokenItem token, int offset)      public  FormatTokenPosition getPosition(TokenItem token, int offset)      Get the token position that corresponds to the given token and offset. public  FormatTokenPosition getPosition(TokenItem token, int offset, Position.Bias bias)      public  FormatTokenPosition getPreviousPosition(TokenItem token, int offset, Position.Bias bias)      Get the previous position of the position given by parameters. public  FormatTokenPosition getPreviousPosition(FormatTokenPosition pos)      Get the token-position preceeding the given one. public  FormatTokenPosition getPreviousPosition(FormatTokenPosition pos, Position.Bias bias)      Get the token-position preceeding the given one. public  FormatTokenPosition getPreviousPosition(TokenItem token, int offset)      public  TokenItem getPreviousToken(TokenItem token)      Get the previous token or last token if the argument is null. public  boolean getSettingBoolean(String settingName, Boolean defaultValue)      public  boolean getSettingBoolean(String settingName, boolean defaultValue)      public  int getSettingInteger(String settingName, Integer defaultValue)      public  int getSettingInteger(String settingName, int defaultValue)      public  Object getSettingValue(String settingName)      public  Object getSettingValue(String settingName, Object defaultValue)      public  int getShiftWidth()      public  int getSpacesPerTab()      public  int getTabSize()      public  FormatTokenPosition getTextStartPosition()      public  TokenContextPath getValidWhitespaceTokenContextPath()      Get the valid whitespace token-context-path by calling getWhitespaceTokenContextPath(). public  TokenID getValidWhitespaceTokenID()      Get the valid whitespace token-id by calling getWhitespaceTokenID(). public  int getVisualColumnOffset(FormatTokenPosition pos)      Get the column-offset of the tokenItem on its line. public  TokenContextPath getWhitespaceTokenContextPath()      Get the token-context-path that should be assigned to the token that consists of the indentation whitespace only. public  TokenID getWhitespaceTokenID()      Get the token-id that should be assigned to the token that consists of the indentation whitespace only. public  void insertSpaces(TokenItem beforeToken, int spaceCount)      public  void insertString(TokenItem token, int offset, String text)      public  void insertString(FormatTokenPosition pos, String text)      public  TokenItem insertToken(TokenItem beforeToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)      Delegation to the same method in format-writer. public  boolean isAfter(TokenItem testedToken, TokenItem afterToken)      public  boolean isAfter(FormatTokenPosition testedPosition, FormatTokenPosition afterPosition)      public  boolean isChainStartPosition(FormatTokenPosition pos)      final public  boolean isIndentOnly()      Delegation to the same method in format-writer. public  boolean isLineEmpty(FormatTokenPosition pos)      Check whether there are no tokens except the ending EOL on the given line. public  boolean isLineWhite(FormatTokenPosition pos)      Check whether there are only the whitespace tokens on the given line. Parameters:   token - any token on the line. public  boolean isRestartFormat()      Delegation to the same method in format-writer. public  boolean isWhitespace(TokenItem token, int offset)      Decide whether the character at the given offset in the given token is whitespace. public  boolean isWhitespace(FormatTokenPosition pos)      public  void remove(TokenItem token, int offset, int length)      public  void remove(FormatTokenPosition pos, int length)      public  void removeToken(TokenItem token)      Remove the token-item from the chain. public  void removeTokenChain(TokenItem startToken, TokenItem endToken)      Remove all the tokens between start and end token inclusive. public  void replaceToken(TokenItem originalToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)      Replace the given token with the new token. public  void setIndentShift(int indentShift)      Delegation to the same method in format-writer. public  void setRestartFormat(boolean restartFormat)      Delegation to the same method in format-writer. public  TokenItem splitEnd(TokenItem token, int endLength, TokenID newTokenID, TokenContextPath newTokenContextPath)      public  TokenItem splitStart(TokenItem token, int startLength, TokenID newTokenID, TokenContextPath newTokenContextPath)      public  boolean tokenEquals(TokenItem compareToken, TokenID withTokenID)      Compare token-id of the compare-token with the given token-id. public  boolean tokenEquals(TokenItem compareToken, TokenID withTokenID, TokenContextPath withTokenContextPath)      Compare token-id of the compare-token with the given token-id and token-context-path. public  boolean tokenEquals(TokenItem compareToken, TokenID withTokenID, TokenContextPath withTokenContextPath, String withTokenImage)      Compare token-id of the compare-token with the given token-id and given token-text. Parameters:   compareToken - token to compare Parameters:   withTokenID - token-id with which the token's token-id is compared.It can be null in which case the token-id is ignored from comparison. Parameters:   withTokenContextPath - token-context-path to whichthe token's token-context-path is compared.It can be null in which case the token-context-path is ignored from comparison. Parameters:   withTokenImage - token-text with which the token's token-text is compared.It can be null in which case the token-text is ignored from comparison. Constructor Detail FormatSupport public FormatSupport(FormatWriter formatWriter)(Code) Method Detail canInsertToken public boolean canInsertToken(TokenItem beforeToken)(Code) Delegation to the same method in format-writer. canModifyWhitespace public boolean canModifyWhitespace(TokenItem inToken)(Code) Check whether the given token enables modifying of a whitespace in it. This method should be overriden in the descendants. canRemoveToken public boolean canRemoveToken(TokenItem token)(Code) Whether the token-item can be removed. It can be removed only in case it doesn't come from the document's text and it wasn't yet written to the underlying writer. canReplaceToken public boolean canReplaceToken(TokenItem token)(Code) Whether the given token can be replaced or not. It's identical to whether the token can be removed. chainToString public String chainToString(TokenItem token)(Code) Debug the current state of the chain. Parameters:   token - mark this token as current one. It can be null. chainToString public String chainToString(TokenItem token, int maxDocumentTokens)(Code) changeLineIndent public FormatTokenPosition changeLineIndent(FormatTokenPosition pos, int indent)(Code) Change the indentation of the line. This method should be always called for all the lines because it ensures that the indentation will contain exactly the characters from the indentation string. Parameters:   pos - any position on the line being checked. Parameters:   indent - the indentation for the line. some position on the line expandTabs public boolean expandTabs()(Code) findFirstToken public TokenItem findFirstToken(TokenItem token)(Code) Get the first token in chain. findLineEnd public FormatTokenPosition findLineEnd(FormatTokenPosition pos)(Code) Get the ending position of the line. It searches for the new-line character and returns the position of it or the position after the last character of the last token in the chain. Parameters:   pos - any token-position on the line. findLineEndWhitespace public FormatTokenPosition findLineEndWhitespace(FormatTokenPosition pos)(Code) Return the ending whitespace on the line or null if there's no such token on the given line. findLineFirstNonWhitespace public FormatTokenPosition findLineFirstNonWhitespace(FormatTokenPosition pos)(Code) Return the first non-whitespace character on the line or null if there is no non-WS char on the line. findLineStart public FormatTokenPosition findLineStart(FormatTokenPosition pos)(Code) Get the starting position of the line. It searches for the new-line character in backward direction and returns the position of the character following the new-line character or the first character of the first token in the chain. Parameters:   pos - any token-position on the line. findNextEOL public FormatTokenPosition findNextEOL(FormatTokenPosition pos)(Code) Get the first EOL in forward direction. Parameters:   pos - starting token-position that is ignored by the searchso it can be even EOL. first EOL token-position in the forward direction or null if thereis no such token. findNonEmptyToken public TokenItem findNonEmptyToken(TokenItem token, boolean backward)(Code) Check whether the given token has empty text and if so start searching for token with non-empty text in the given direction. If there's no non-empty token in the given direction the method returns null. findNonWhitespace public FormatTokenPosition findNonWhitespace(FormatTokenPosition startPosition, FormatTokenPosition limitPosition, boolean stopOnEOL, boolean backward)(Code) Get the first non-whitespace position in the given direction. Parameters:   startPosition - position at which the search starts.For the backward search the character right at startPositionis not considered as part of the search. Parameters:   limitPosition - the token where the search will be brokenreporting that nothing was found. It can be null to searchtill the end or begining of the chain (depending on direction).For forward search the char at the limitPositionis not considered to be part of search,but for backward search it is. Parameters:   stopOnEOL - whether stop and return EOL positionor continue search if EOL token is found. Parameters:   backward - whether search in backward direction. first non-whitespace position or EOL or null if all the tokenstill the begining of the chain are whitespaces. findPreviousEOL public FormatTokenPosition findPreviousEOL(FormatTokenPosition pos)(Code) Get the first EOL in backward direction. The current position is ignored by the search. first EOL in backward direction or null if thereis no such token. getFormatStartPosition public FormatTokenPosition getFormatStartPosition()(Code) Delegation to the same method in format-writer. getFormatWriter public FormatWriter getFormatWriter()(Code) Getter for the format-writer associated with this format-support. getIndentShift public int getIndentShift()(Code) Delegation to the same method in format-writer. getIndentString public String getIndentString(int indent)(Code) This delegates to the same method in formatter. getLastPosition public FormatTokenPosition getLastPosition()(Code) getLastToken public TokenItem getLastToken()(Code) Delegation to the same method in format-writer. getLineIndent public int getLineIndent(FormatTokenPosition pos, boolean zeroForWSLine)(Code) Get the indentation of the line. Parameters:   formatTokenPosition - any position on the line.It doesn't have to be the first one. Parameters:   zeroForWSLine - If set to true the method will return zeroin case the line consist of whitespace only. If falsethe method will return the indentation even for whitespacelines. getNextPosition public FormatTokenPosition getNextPosition(TokenItem token, int offset, Position.Bias bias)(Code) Get the next position of the position given by parameters. It can be either just offset increasing but it can be movement to the next token for the token boundary. next token-position or null for the EOT position getNextPosition public FormatTokenPosition getNextPosition(FormatTokenPosition pos)(Code) Get the next successive token-position after the given one. Use the same bias like the given position has. getNextPosition public FormatTokenPosition getNextPosition(FormatTokenPosition pos, Position.Bias bias)(Code) Get the token-position preceeding the given one. Parameters:   bias - bias that the returned position will have. getNextPosition public FormatTokenPosition getNextPosition(TokenItem token, int offset)(Code) getPosition public FormatTokenPosition getPosition(TokenItem token, int offset)(Code) Get the token position that corresponds to the given token and offset. Parameters:   token - token for which the token-position is being created. Parameters:   offset - offset inside the token. getPosition public FormatTokenPosition getPosition(TokenItem token, int offset, Position.Bias bias)(Code) getPreviousPosition public FormatTokenPosition getPreviousPosition(TokenItem token, int offset, Position.Bias bias)(Code) Get the previous position of the position given by parameters. It can be either just offset decreasing but it can be movement to the previous token for the token boundary. next token-position or null for the first position in the chain getPreviousPosition public FormatTokenPosition getPreviousPosition(FormatTokenPosition pos)(Code) Get the token-position preceeding the given one. Use the same bias like the given position has. getPreviousPosition public FormatTokenPosition getPreviousPosition(FormatTokenPosition pos, Position.Bias bias)(Code) Get the token-position preceeding the given one. Parameters:   bias - bias that the returned position will have. getPreviousPosition public FormatTokenPosition getPreviousPosition(TokenItem token, int offset)(Code) getPreviousToken public TokenItem getPreviousToken(TokenItem token)(Code) Get the previous token or last token if the argument is null. getSettingBoolean public boolean getSettingBoolean(String settingName, Boolean defaultValue)(Code) getSettingBoolean public boolean getSettingBoolean(String settingName, boolean defaultValue)(Code) getSettingInteger public int getSettingInteger(String settingName, Integer defaultValue)(Code) getSettingInteger public int getSettingInteger(String settingName, int defaultValue)(Code) getSettingValue public Object getSettingValue(String settingName)(Code) getSettingValue public Object getSettingValue(String settingName, Object defaultValue)(Code) getShiftWidth public int getShiftWidth()(Code) getSpacesPerTab public int getSpacesPerTab()(Code) getTabSize public int getTabSize()(Code) getTextStartPosition public FormatTokenPosition getTextStartPosition()(Code) getValidWhitespaceTokenContextPath public TokenContextPath getValidWhitespaceTokenContextPath()(Code) Get the valid whitespace token-context-path by calling getWhitespaceTokenContextPath(). Throw IllegalStateException if the whitespace-token-id is null. getValidWhitespaceTokenID public TokenID getValidWhitespaceTokenID()(Code) Get the valid whitespace token-id by calling getWhitespaceTokenID(). Throw IllegalStateException if the whitespace-token-id is null. getVisualColumnOffset public int getVisualColumnOffset(FormatTokenPosition pos)(Code) Get the column-offset of the tokenItem on its line. The tabs are expanded according to the tab-size. getWhitespaceTokenContextPath public TokenContextPath getWhitespaceTokenContextPath()(Code) Get the token-context-path that should be assigned to the token that consists of the indentation whitespace only. This method should be overriden in the descendants. getWhitespaceTokenID public TokenID getWhitespaceTokenID()(Code) Get the token-id that should be assigned to the token that consists of the indentation whitespace only. This method should be overriden in the descendants. insertSpaces public void insertSpaces(TokenItem beforeToken, int spaceCount)(Code) insertString public void insertString(TokenItem token, int offset, String text)(Code) insertString public void insertString(FormatTokenPosition pos, String text)(Code) insertToken public TokenItem insertToken(TokenItem beforeToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)(Code) Delegation to the same method in format-writer. isAfter public boolean isAfter(TokenItem testedToken, TokenItem afterToken)(Code) isAfter public boolean isAfter(FormatTokenPosition testedPosition, FormatTokenPosition afterPosition)(Code) isChainStartPosition public boolean isChainStartPosition(FormatTokenPosition pos)(Code) isIndentOnly final public boolean isIndentOnly()(Code) Delegation to the same method in format-writer. isLineEmpty public boolean isLineEmpty(FormatTokenPosition pos)(Code) Check whether there are no tokens except the ending EOL on the given line. Parameters:   pos - any position on the line isLineWhite public boolean isLineWhite(FormatTokenPosition pos)(Code) Check whether there are only the whitespace tokens on the given line. Parameters:   token - any token on the line. It doesn't have to be the first one. isRestartFormat public boolean isRestartFormat()(Code) Delegation to the same method in format-writer. isWhitespace public boolean isWhitespace(TokenItem token, int offset)(Code) Decide whether the character at the given offset in the given token is whitespace. isWhitespace public boolean isWhitespace(FormatTokenPosition pos)(Code) remove public void remove(TokenItem token, int offset, int length)(Code) remove public void remove(FormatTokenPosition pos, int length)(Code) removeToken public void removeToken(TokenItem token)(Code) Remove the token-item from the chain. It can be removed only in case it doesn't come from the document's text and it wasn't yet written to the underlying writer. removeTokenChain public void removeTokenChain(TokenItem startToken, TokenItem endToken)(Code) Remove all the tokens between start and end token inclusive. replaceToken public void replaceToken(TokenItem originalToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)(Code) Replace the given token with the new token. Parameters:   originalToken - original token to be replaced. Parameters:   tokenID - token-id of the new token-item Parameters:   tokenContextPath - token-context-path of the new token-item Parameters:   tokenImage - token-text of the new token-item setIndentShift public void setIndentShift(int indentShift)(Code) Delegation to the same method in format-writer. setRestartFormat public void setRestartFormat(boolean restartFormat)(Code) Delegation to the same method in format-writer. splitEnd public TokenItem splitEnd(TokenItem token, int endLength, TokenID newTokenID, TokenContextPath newTokenContextPath)(Code) splitStart public TokenItem splitStart(TokenItem token, int startLength, TokenID newTokenID, TokenContextPath newTokenContextPath)(Code) tokenEquals public boolean tokenEquals(TokenItem compareToken, TokenID withTokenID)(Code) Compare token-id of the compare-token with the given token-id. Token text and token-context-path are ignored in comparison. Parameters:   compareToken - token to compare Parameters:   withTokenID - token-id with which the token's token-id is compared true if the token-ids match, false otherwise tokenEquals public boolean tokenEquals(TokenItem compareToken, TokenID withTokenID, TokenContextPath withTokenContextPath)(Code) Compare token-id of the compare-token with the given token-id and token-context-path. Token text is ignored in comparison. Parameters:   compareToken - token to compare Parameters:   withTokenID - token-id with which the token's token-id is compared. Parameters:   withTokenContextPath - token-context-path to whichthe token's token-context-path is compared. true if the token-ids match, false otherwise tokenEquals public boolean tokenEquals(TokenItem compareToken, TokenID withTokenID, TokenContextPath withTokenContextPath, String withTokenImage)(Code) Compare token-id of the compare-token with the given token-id and given token-text. Parameters:   compareToken - token to compare Parameters:   withTokenID - token-id with which the token's token-id is compared.It can be null in which case the token-id is ignored from comparison. Parameters:   withTokenContextPath - token-context-path to whichthe token's token-context-path is compared.It can be null in which case the token-context-path is ignored from comparison. Parameters:   withTokenImage - token-text with which the token's token-text is compared.It can be null in which case the token-text is ignored from comparison. true if the token-ids and token-texts match, false otherwise Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)